@balena/jellyfish-environment NPM

Jellyfish environment

Environment variable library for Jellyfish.

This module aims to be the startup system configuration hub and exposes any runtime settings to the rest of the system. Its the only place in the codebase that should ever read environment variables.

Usage

Below is an example how to use this library:

const environment = require('@balena/jellyfish-environment')

console.log(`Metrics Token: ${environment.metrics.token}`)

Documentation

A module that sets up the Jellyfish system configuration using environment variables.

environment
- ~Environment
  - new Environment(environment)
  - .isProduction() ⇒ Boolean
  - .isDevelopment() ⇒ Boolean
  - .isCI() ⇒ Boolean
  - .getString(name, fallback) ⇒ String
  - .getNumber(name, fallback) ⇒ Number
- ~init(env) ⇒ Object

environment~Environment

Read and return values for a subset of environment variables. Can dependency inject environment in constructor, falls back to process.env.

Kind: inner class of environment

~Environment
- new Environment(environment)
- .isProduction() ⇒ Boolean
- .isDevelopment() ⇒ Boolean
- .isCI() ⇒ Boolean
- .getString(name, fallback) ⇒ String
- .getNumber(name, fallback) ⇒ Number

new Environment(environment)

Constructor.

Param	Type	Description
environment	Object	environment variable object, defaults to process.env

environment.isProduction() ⇒ Boolean

Kind: instance method of Environment
Summary: Check if the code is running in a production environment
Returns: Boolean - Whether the environment is production
Access: public
Example

if (environment.isProduction()) {
  console.log('production environment')
}

environment.isDevelopment() ⇒ Boolean

Kind: instance method of Environment
Summary: Check if the code is running in a development environment
Returns: Boolean - Whether the environment is development
Access: public
Example

if (environment.isDevelopment()) {
  console.log('development environment')
}

environment.isCI() ⇒ Boolean

Kind: instance method of Environment
Summary: Check if the code is running in a CI environment
Returns: Boolean - Whether the environment is a CI system
Access: public
Example

if (environment.isCI()) {
  console.log('running in CI')
}

environment.getString(name, fallback) ⇒ String

Kind: instance method of Environment
Summary: Get and return the string value of an environment variable.
Returns: String - environment variable value
Access: public

Param	Type	Description
name	String	environment variable name
fallback	String	fallback value

environment.getNumber(name, fallback) ⇒ Number

Kind: instance method of Environment
Summary: Get and return the number value of an environment variable.
Returns: Number - environment variable value
Access: public

Param	Type	Default	Description
name	String		environment variable name
fallback	Number	0	fallback value

environment~init(env) ⇒ Object

Kind: inner method of environment
Summary: Create Environment instance and return variables and public functions
Returns: Object - list of environment variables and public functions
Access: public