@google-cloud/rcloadenv

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

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
102Jun 11, 2021Nov 29, 2018Minified + gzip package size for @google-cloud/rcloadenv in KB

Readme

Google Cloud Platform logo

Google Cloud Runtime Config: Node.js Client

release level npm version codecov

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 in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client 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 the API from your local workstation.

Installing the client library

npm install @google-cloud/rcloadenv

Using the client library

// import the npm module
const 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 the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Quickstart source code Open in Cloud Shell

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(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 versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

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

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

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 template in this directory.

License

Apache Version 2.0

See LICENSE

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.