Google Cloud Runtime Config: Node.js Client

release levelnpm versioncodecov

Node.js implementation of rcloadenv. Wraps execution of a given command and loads variables from the Google Cloud Runtime Config API into that process.

A comprehensive list of changes in each version may be found inthe CHANGELOG.

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable the Google Cloud Runtime Config API.
  3. Set up authentication with a service account so you can access theAPI from your local workstation.

Installing the client library

npm install @google-cloud/rcloadenv

Using the client library

// import the npm moduleconst rcloadenv = require('@google-cloud/rcloadenv');async function quickstart() {  // Just load raw variables from the Runtime Config service:  const vars = await rcloadenv.getVariables('my-config');  console.log(`${vars.length} variables found!`);  vars.forEach(console.log);  // Load the variables and apply them to the current environment  await rcloadenv.getAndApply('my-config');  console.log(process.env.fruit);  // Load the variables and mix them into a provided object  const newEnv = Object.assign({}, process.env);  const env = await rcloadenv.getAndApply('my-config', newEnv);  console.log(env.veggie);}quickstart();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Quickstartsource codeOpen in Cloud Shell

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.

Client libraries targeting some end-of-life versions of Node.js are available, andcan be installed via npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versionscompatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inbeta. This means it is expected to bemostly stable while we work toward a general availability release; however,complete stability is not guaranteed. We will address issues and requestsagainst beta libraries with a high priority.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.