Class ConfigMap<Data>

ConfigMap

Example

type ConfigEnv = {
	 PORT: number;
	 HOST: string;
	 DEBUG: boolean;
	 URL: URL;
};
const config = new ConfigMap<ConfigEnv>({
	 DEBUG: {loaders: [env()], parser: booleanParser, defaultValue: false},
	 HOST: {loaders: [env()], parser: stringParser, defaultValue: 'localhost'},
	 PORT: {loaders: [env()], parser: integerParser, defaultValue: 3000},
	 URL: {loaders: [env()], parser: new UrlParser({urlSanitize: true}), defaultValue: new URL('http://localhost:3000')},
});
console.log('port', await config.get('PORT'));

Since

v1.1.0

Type Parameters

Data extends Record<string, unknown>
type of config map

Implements

ISetOptionalLogger

Index

Constructors

constructor

Methods

get getAllObjects getAllStringValues getAllValues getObject getObjectResult getResult getString getStringResult setLogger validateAll

Constructors

constructor

new ConfigMap<Data extends Record<string, unknown>>(
    schema: EnvMapSchema<Data>,
    loaders: Loadable<Iterable<IConfigLoader, any, any>>,
    options?: ConfigOptions,
): ConfigMap<Data>
ConfigMap constructor
Type Parameters
- Data extends Record<string, unknown>
Parameters
- schema: EnvMapSchema<Data>
  schema of config map
- loaders: Loadable<Iterable<IConfigLoader, any, any>>
  iterable of config loaders
- options: ConfigOptions = ...
  optional config options (logger, namespace)
Returns ConfigMap<Data>
- Defined in src/ConfigMap.ts:49

Methods

get

get<Key extends string | number | symbol = keyof Data>(
key: Key,
encodeOptions?: EncodeOptions,
): Promise<Data[Key]>
get env value from config map
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
  key of config map
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<Data[Key]>
Promise of value or undefined
Example
```
const port: number = await config.get('PORT');
```
- Defined in src/ConfigMap.ts:123

getAllObjects

getAllObjects(): Promise<TypeValueRecords<Data>>
get all env value objects from config map

Returns Promise<TypeValueRecords<Data>>
Promise of all values
Example
```
const values: TypeValueRecords<Data> = await config.getAll();
console.log(values.PORT.type, values.PORT.value); // 'env', 3000
```
- Defined in src/ConfigMap.ts:190

getAllStringValues

getAllStringValues(
encodeOptions?: EncodeOptions,
): Promise<Record<keyof Data, string>>
get all env values from config map as string
Parameters
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<Record<keyof Data, string>>
Promise of all values as string
Example
```
const values: Record<keyof Data, string> = await config.getAllStringValues();
console.log('PORT', values.PORT); // '3000' (string)
```
- Defined in src/ConfigMap.ts:221

getAllValues

getAllValues(): Promise<Data>
get all env values from config map

Returns Promise<Data>
Promise of all values
Example
```
const values: Data = await config.getAllValues();
console.log('PORT', values.PORT); // 3000 (number)
```
- Defined in src/ConfigMap.ts:205

getObject

getObject<Key extends string | number | symbol = keyof Data>(
key: Key,
encodeOptions?: EncodeOptions,
): Promise<LoaderTypeValueStrict<Data[Key]>>
get env object from config map
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
  key of config map
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<LoaderTypeValueStrict<Data[Key]>>
Promise of env object or undefined
Example
```
const valueObject: LoaderTypeValue<number> = await config.getObject('PORT');
console.log(valueObject.type, valueObject.value); // 'env', 3000
```
- Defined in src/ConfigMap.ts:72

getObjectResult

getObjectResult<Key extends string | number | symbol = keyof Data>(
key: Key,
encodeOptions?: EncodeOptions,
): Promise<IResult<LoaderTypeValueStrict<Data[Key]>>>
get env object from config map as Result
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
  key of config map
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<IResult<LoaderTypeValueStrict<Data[Key]>>>
Result Promise of env object or undefined
Example
```
const valueObject: Result<LoaderTypeValue<number>> = await config.getObjectResult('PORT');
if (valueObject.isOk()) {
  const {type, value} = valueObject.ok();
	 console.log(type, value); // 'env', 3000
}
```
- Defined in src/ConfigMap.ts:104

getResult

getResult<Key extends string | number | symbol = keyof Data>(
key: Key,
encodeOptions?: EncodeOptions,
): Promise<IResult<Data[Key]>>
get env value from config map as Result
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
  key of config map
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<IResult<Data[Key]>>
Result Promise of value or undefined
Example
```
const port: Result<number> = await config.getResult('PORT');
if (port.isOk()) {
	 console.log('port', port.ok());
}
```
- Defined in src/ConfigMap.ts:153

getString

getString<Key extends string | number | symbol = keyof Data>(
key: Key,
encodeOptions?: EncodeOptions,
): Promise<undefined extends Data[Key] ? string | undefined : string>
get env value as string from config map
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
  key of config map
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<undefined extends Data[Key] ? string | undefined : string>
Promise of string value or undefined
Example
```
const port: string = await config.getString('PORT');
```
- Defined in src/ConfigMap.ts:135

getStringResult

getStringResult<Key extends string | number | symbol = keyof Data>(
    key: Key,
    encodeOptions?: EncodeOptions,
): Promise<
    IResult<undefined extends Data[Key] ? string | undefined : string>,
>
get env value as string from config map as Result
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
  key of config map
- OptionalencodeOptions: EncodeOptions
  optional encode options
Returns Promise<IResult<undefined extends Data[Key] ? string | undefined : string>>
Result Promise of string value or undefined
Example
```
const port: Result<string> = await config.getStringResult('PORT');
if (port.isOk()) {
	 console.log('port', port.ok());
}
```
- Defined in src/ConfigMap.ts:172

setLogger

setLogger(logger: undefined | ILoggerLike): void
Set logger value
Parameters
- logger: undefined | ILoggerLike
  logger like object
Returns void
Implementation of ISetOptionalLogger.setLogger
- Defined in src/ConfigMap.ts:59

validateAll

validateAll(callback: (data: Data) => void): Promise<void>
Validate all env values from config map, expect to throw error if error exists
Parameters
- callback: (data: Data) => void
  callback function
Returns Promise<void>
- Defined in src/ConfigMap.ts:236

Class ConfigMap<Data>

Example

Since

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ConfigMap<Data>

Methods

get

Type Parameters

Parameters

Returns Promise<Data[Key]>

Example

getAllObjects

Returns Promise<TypeValueRecords<Data>>

Example

getAllStringValues

Parameters

Returns Promise<Record<keyof Data, string>>

Example

getAllValues

Returns Promise<Data>

Example

getObject

Type Parameters

Parameters

Returns Promise<LoaderTypeValueStrict<Data[Key]>>

Example

getObjectResult

Type Parameters

Parameters

Returns Promise<IResult<LoaderTypeValueStrict<Data[Key]>>>

Example

getResult

Type Parameters

Parameters

Returns Promise<IResult<Data[Key]>>

Example

getString

Type Parameters

Parameters

Returns Promise<undefined extends Data[Key] ? string | undefined : string>

Example

getStringResult

Type Parameters

Parameters

Returns Promise<IResult<undefined extends Data[Key] ? string | undefined : string>>

Example

setLogger

Parameters

Returns void

validateAll

Parameters

Returns Promise<void>

Settings

On This Page