/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The resource name of the instance location using the form:
* `projects/{project_id}/locations/{location_id}`
* where `location_id` refers to a GCP region
*/
// const parent = 'abc123'
/**
* The maximum number of items to return.
* If not specified, a default value of 1000 will be used by the service.
* Regardless of the page_size value, the response may include a partial list
* and a caller should only rely on response's
* next_page_token CloudMemcache.ListInstancesResponse.next_page_token
* to determine if there are more instances left to be queried.
*/
// const pageSize = 1234
/**
* The next_page_token value returned from a previous List request,
* if any.
*/
// const pageToken = 'abc123'
/**
* List filter. For example, exclude all Memcached instances with name as
* my-instance by specifying "name != my-instance".
*/
// const filter = 'abc123'
/**
* Sort results. Supported values are "name", "name desc" or "" (unsorted).
*/
// const orderBy = 'abc123'
// Imports the Memcache library
const {CloudMemcacheClient} = require('@google-cloud/memcache').v1;
// Instantiates a client
const memcacheClient = new CloudMemcacheClient();
async function callListInstances() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await memcacheClient.listInstancesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListInstances();
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
Our client libraries follow the Node.js release schedule.
Libraries are compatible with all current active and maintenance versions of
Node.js.
If you are using an end-of-life version of Node.js, we recommend that you update
as soon as possible to an actively supported LTS version.
Google's client libraries support legacy versions of Node.js runtimes on a
best-efforts basis with the following warnings:
Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.
Client libraries targeting some end-of-life versions of Node.js are available, and
can be installed through npm dist-tags.
The dist-tags follow the naming convention legacy-(version).
For example, npm install @google-cloud/memcache@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library is considered to be stable. The code surface will not change in backwards-incompatible ways
unless absolutely necessary (e.g. because of critical security issues) or with
an extensive deprecation period. Issues and requests against stable libraries
are addressed with the highest priority.
Please note that this README.md, the samples/README.md,
and a variety of configuration files in this repository (including .nycrc and tsconfig.json)
are generated from a central template. To edit one of these files, make an edit
to its templates in
directory.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["Version latestkeyboard_arrow_down\n\n- [4.1.0 (latest)](/nodejs/docs/reference/memcache/latest)\n- [2.3.2](/nodejs/docs/reference/memcache/2.3.2)\n- [2.1.4](/nodejs/docs/reference/memcache/2.1.4)\n- [1.5.1](/nodejs/docs/reference/memcache/1.5.1)\n- [1.4.7](/nodejs/docs/reference/memcache/1.4.7) \n\n[Memorystore for Memcached: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-memcache)\n=====================================================================================================================================\n\n[](https://cloud.google.com/terms/launch-stages)\n[](https://www.npmjs.org/package/@google-cloud/memcache)\n\nMemcache client for Node.js\n\nA comprehensive list of changes in each version may be found in\n[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-memcache/CHANGELOG.md).\n\n- [Memorystore for Memcached Node.js Client API Reference](https://cloud.google.com/nodejs/docs/reference/memcache/latest)\n- [Memorystore for Memcached Documentation](https://cloud.google.com/memorystore/docs/memcached)\n- [github.com/googleapis/google-cloud-node/packages/google-cloud-memcache](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-memcache)\n\nRead more about the client libraries for Cloud APIs, including the older\nGoogle APIs Client Libraries, in [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained).\n\n**Table of contents:**\n\n- [Quickstart](#quickstart)\n - [Before you begin](#before-you-begin)\n - [Installing the client library](#installing-the-client-library)\n - [Using the client library](#using-the-client-library)\n- [Samples](#samples)\n- [Versioning](#versioning)\n- [Contributing](#contributing)\n- [License](#license)\n\nQuickstart\n----------\n\n### Before you begin\n\n1. [Select or create a Cloud Platform project](https://console.cloud.google.com/project).\n2. [Enable billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing).\n3. [Enable the Memorystore for Memcached API](https://console.cloud.google.com/flows/enableapi?apiid=memcache.googleapis.com).\n4. [Set up authentication](https://cloud.google.com/docs/authentication/external/set-up-adc-local) so you can access the API from your local workstation.\n\n### Installing the client library\n\n npm install @google-cloud/memcache\n\n### Using the client library\n\n /**\n * This snippet has been automatically generated and should be regarded as a code template only.\n * It will require modifications to work.\n * It may require correct/in-range values for request initialization.\n * TODO(developer): Uncomment these variables before running the sample.\n */\n /**\n * Required. The resource name of the instance location using the form:\n * `projects/{project_id}/locations/{location_id}`\n * where `location_id` refers to a GCP region\n */\n // const parent = 'abc123'\n /**\n * The maximum number of items to return.\n * If not specified, a default value of 1000 will be used by the service.\n * Regardless of the page_size value, the response may include a partial list\n * and a caller should only rely on response's\n * next_page_token CloudMemcache.ListInstancesResponse.next_page_token\n * to determine if there are more instances left to be queried.\n */\n // const pageSize = 1234\n /**\n * The next_page_token value returned from a previous List request,\n * if any.\n */\n // const pageToken = 'abc123'\n /**\n * List filter. For example, exclude all Memcached instances with name as\n * my-instance by specifying \"name != my-instance\".\n */\n // const filter = 'abc123'\n /**\n * Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).\n */\n // const orderBy = 'abc123'\n\n // Imports the Memcache library\n const {CloudMemcacheClient} = require('https://cloud.google.com/nodejs/docs/reference/memcache/latest/overview.html').v1;\n\n // Instantiates a client\n const memcacheClient = new https://cloud.google.com/nodejs/docs/reference/memcache/latest/overview.html();\n\n async function callListInstances() {\n // Construct request\n const request = {\n parent,\n };\n\n // Run request\n const iterable = await memcacheClient.listInstancesAsync(request);\n for await (const response of iterable) {\n console.log(response);\n }\n }\n\n callListInstances();\n\nSamples\n-------\n\nSamples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-memcache/samples) directory. Each sample's `README.md` has instructions for running its sample.\n\nThe [Memorystore for Memcached Node.js Client API Reference](https://cloud.google.com/nodejs/docs/reference/memcache/latest) documentation\nalso contains samples.\n\nSupported Node.js Versions\n--------------------------\n\nOur client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).\nLibraries are compatible with all current *active* and *maintenance* versions of\nNode.js.\nIf you are using an end-of-life version of Node.js, we recommend that you update\nas soon as possible to an actively supported LTS version.\n\nGoogle's client libraries support legacy versions of Node.js runtimes on a\nbest-efforts basis with the following warnings:\n\n- Legacy versions are not tested in continuous integration.\n- Some security patches and features cannot be backported.\n- Dependencies cannot be kept up-to-date.\n\nClient libraries targeting some end-of-life versions of Node.js are available, and\ncan be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).\nThe dist-tags follow the naming convention `legacy-(version)`.\nFor example, `npm install @google-cloud/memcache@legacy-8` installs client libraries\nfor versions compatible with Node.js 8.\n\nVersioning\n----------\n\nThis library follows [Semantic Versioning](http://semver.org/).\n\nThis library is considered to be **stable** . The code surface will not change in backwards-incompatible ways\nunless absolutely necessary (e.g. because of critical security issues) or with\nan extensive deprecation period. Issues and requests against **stable** libraries\nare addressed with the highest priority.\n\nMore Information: [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages)\n\nContributing\n------------\n\nContributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).\n\nPlease note that this `README.md`, the `samples/README.md`,\nand a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)\nare generated from a central template. To edit one of these files, make an edit\nto its templates in\n[directory](https://github.com/googleapis/synthtool).\n\nLicense\n-------\n\nApache Version 2.0\n\nSee [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)"]]
