Class FileConfigSource

Reads configuration from a local JSON or YAML file.

The format is inferred from the extension (.yml/.yaml -> YAML, else JSON) unless given. A missing file throws, unless optional is set (then it yields {}).

Implements

ConfigSource

Index

Constructors

Properties

Methods

Constructors

constructor

new FileConfigSource(options: FileSourceOptions): FileConfigSource
Parameters
- options: FileSourceOptions
  The source options.
Returns FileConfigSource

Properties

`Readonly`name

name: string = 'file'

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: FileSourceOptions): FileConfigSource
Create a file source.
Parameters
- options: FileSourceOptions
  The source options.
Returns FileConfigSource
A new source.