Class EnvConfigSource

Reads configuration from environment variables.

The zero-config default source. With a prefix, only matching variables are kept and the prefix is stripped (APP_DB_URL -> DB_URL).

Implements

ConfigSource

Index

Constructors

Properties

Methods

Constructors

constructor

new EnvConfigSource(options?: EnvSourceOptions): EnvConfigSource
Parameters
- options: EnvSourceOptions = {}
  The source options.
Returns EnvConfigSource

Properties

`Readonly`name

name: string = 'env'

A human-readable name (e.g. env, file, ssm).

Methods

load

load(): Promise<Record<string, unknown>>

Returns Promise<Record<string, unknown>>

Inherit Doc

Implementation of ConfigSource.load

`Static`create

create(options?: EnvSourceOptions): EnvConfigSource
Create an environment source.
Parameters
- options: EnvSourceOptions = {}
  The source options.
Returns EnvConfigSource
A new source.