@americanexpress/env-config-utils

This contains utilities for configuring environment variables including functions for preprocessing.

👩‍💻 Hiring 👨‍💻

Want to get paid for your contributions to env-config-utils?

Send your resume to [e-mail]

📖 Table of Contents

• Features
• Usage
• API
• Contributing

✨ Features

• Validate environment variables.
• Normalize any environment variables.
• Set default value for the environment variables.
• Provide valid environment variables options.

🤹‍ Usage

Installation

npm i @americanexpress/env-config-utils

Checkout the different parameters you can use under the API section.

const { preprocessEnvVar } = require('@americanexpress/env-config-utils');

const config = {
  name: 'HTTP_PORT',
  normalize: (input) => {
    const parsed = parseInt(input, 10);
    if (Number.isNaN(parsed) || parsed != input) {
      throw new Error(`env var HTTP_PORT needs to be a valid integer, given "${input}"`);
    } else {
      return parsed;
    }
  },
  defaultValue: () => 3000,
};

preprocessEnvVar(config);
const isFetchableUrlInNode = require('@americanexpress/env-config-utils/isFetchableUrlInNode');
// throws if not a valid url
isFetchableUrlInNode('https://example.aexp.com/path');

🎛️ API

preprocessEnvVar( [config] )

Processes environment variables and applies validations and defaults.

config( you can give this any name)

Type: object

provide an object that can be given any name with the below parameters.

name

Type: string

This is the name of the environment variable and refers to process.env[name] REQUIRED

normalize

Type: function

This is a function that takes a value an performs preprocessing on it before the value is set on the environment variable.

valid

Type: array

An optional array of valid values.

defaultValue

Type: string/function

An optional value to use if none is defined

validate

Type: function

An optional function to validate if the provided value is acceptable. Throws an error.

isFetchableUrlInBrowser()

Validates that a given URL is valid when called from the browser. Useful for usage as a validate function for preprocessEnvVar()

url

Type: string

Url to validate.

Usage with preprocessEnvVar()

const {
    name: 'MY_V_COOL_API_URL',
    validate: isFetchableUrlInBrowser,
} = config;

preprocessEnvVar(config);

isFetchableUrlInNode()

Validates that a given URL is valid when called from the server. Useful for usage as a validate function for preprocessEnvVar()

url

Type: string

Url to validate.

Usage with preprocessEnvVar()

const {
    name: 'MY_V_COOL_API_URL',
    validate: isFetchableUrlInNode,
} = config;

preprocessEnvVar(config);

🏆 Contributing

We welcome Your interest in the American Express Open Source Community on Github. Any Contributor to any Open Source Project managed by the American Express Open Source Community must accept and sign an Agreement indicating agreement to the terms below. Except for the rights granted in this Agreement to American Express and to recipients of software distributed by American Express, You reserve all right, title, and interest, if any, in and to Your Contributions. Please fill out the Agreement.

Please feel free to open pull requests and see CONTRIBUTING.md to learn how to get started contributing.

🗝️ License

Any contributions made under this project will be governed by the Apache License 2.0.

🗣️ Code of Conduct

This project adheres to the American Express Community Guidelines. By participating, you are expected to honor these guidelines.