env_helper_ts v1.1.16

env_helper_ts

Env helper is a helper extension library layer provided for the Code 3 code base. It's design was to provide a unified and easy means of retrieving .env configuration variables from files.

Files

• EnvChecker.ts - Has most of the real functionality of this extension library and exposes several methods that may help programmers check.env related configurations.
• Converter.ts - Is an abstract base class that all the other converters are based off of.
• To{Converter}.ts - All of the converters (such as: ToNumber.ts) convert a given string into their the type indicated by their class name. (So ToNumber would convert a given string loaded from a .env file to a number.)

Installation

Install the npm package:

$ npm install env_helper_ts

This is intended to be used as an NPM Package, but if you want to add your own type conversion you can compile it and test it using the commands below:

Build :hammer:

$ npm install
$ npm start

Test :mag_right:

$ npm test

Usage :bowtie:

const secretObjects = [
  { name: "DB_TEST", value: "someConnectionString" },
  { name: "myTestKey", value: "YAYAYA" },
  { name: "aNumber", value: 1 }
];
const secretNames = ["DB_TEST", "myTestKey", "aNumber"];

const myVault = new Vault(clientID, clientSecret, loginAPI, vaultAPI);
myVault
  .getAccessToken() // Get the access token. First operation required for operating on the class
  .then(() => {
    return Promise.all(myVault.setSecretsInVault(setSecrets)); // Set the secrets in the key vault
  })
  .then(() => {
    return Promise.all(myVault.getSecretsFromVault(getSecrets)); // Get the secrets in the key vault
  })
  .then(secrets => {
    console.log(secrets); // Array of {name, value, contentType}
  })
  .catch(error => {
    console.log(error); // 4xx - 5xx level network errors
  })
  .finally(() => {
    getSecrets.forEach(secret => {
      console.log(process.env[secret]); // All get and set operations cache secret in the process.env object
    });
    console.log(typeof getRequiredEnv("aNumber", ToNumber)); // Continue to use getRequiredEnv with type conversion
  });