Class FileConfigSource

A config source that loads configuration from a local file.

Implements

ConfigSource

Index

Methods

readConfigData toString create

Methods

readConfigData

readConfigData(options?: ReadConfigDataOptions): AsyncConfigSourceGenerator
Parameters
- Optionaloptions: ReadConfigDataOptions
Returns AsyncConfigSourceGenerator
Implementation of ConfigSource.readConfigData
- Defined in packages/config-loader/src/sources/FileConfigSource.ts:116

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in packages/config-loader/src/sources/FileConfigSource.ts:202

`Static`create

create(options: FileConfigSourceOptions): ConfigSource
Creates a new config source that loads configuration from the given path.
Parameters
- options: FileConfigSourceOptions
  Options for the config source.
Returns ConfigSource
A new config source that loads from the given path.

Remarks
The source will watch the file for changes, as well as any referenced files.
- Defined in packages/config-loader/src/sources/FileConfigSource.ts:94