Class ConfigMap<Data>

ConfigMap

Example

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

Since

v1.1.0

Type Parameters

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

Constructors

constructor

new ConfigMap<Data extends Record<string, unknown>>(
    schema: EnvMapSchema<Data>,
    loaders:
        | Iterable<IConfigLoader, any, any>
        | Promise<Iterable<IConfigLoader, any, any>>
        | (
            (
                ...args: any[],
            ) =>
                | Iterable<IConfigLoader, any, any>
                | Promise<Iterable<IConfigLoader, any, any>>
        ),
    options?: ConfigOptions,
): ConfigMap<Data>
ConfigMap constructor
Type Parameters
- Data extends Record<string, unknown>
  type of config map
Parameters
- schema: EnvMapSchema<Data>
  schema of config map
- loaders:
      | Iterable<IConfigLoader, any, any>
      | Promise<Iterable<IConfigLoader, any, any>>
      | (
          (
              ...args: any[],
          ) =>
              | Iterable<IConfigLoader, any, any>
              | Promise<Iterable<IConfigLoader, any, any>>
      )
  iterable of config loaders
- options: ConfigOptions = ...
  optional config options (logger, namespace)
Returns ConfigMap<Data>
- Defined in packages/variable-util/src/ConfigMap.ts:54

Methods

ensure

ensure(
lookupKeys: keyof Data | Iterable<keyof Data, any, any>,
encodeOptions?: EncodeOptions,
): Promise<IResult<void>>
Ensure that the specified keys are loaded and cached in the ConfigMap. If any key fails to load, the error will be returned.
Parameters
- lookupKeys: keyof Data | Iterable<keyof Data, any, any>
  The key or iterable of keys to ensure are loaded.
- OptionalencodeOptions: EncodeOptions
  Optional encode options to use when loading the keys.
Returns Promise<IResult<void>>
- A promise that resolves to an IResult indicating success or failure. If any key fails to load, the error will be returned.
- Defined in packages/variable-util/src/ConfigMap.ts:202

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 packages/variable-util/src/ConfigMap.ts:136

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 packages/variable-util/src/ConfigMap.ts:306

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 packages/variable-util/src/ConfigMap.ts:340

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 packages/variable-util/src/ConfigMap.ts:324

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 packages/variable-util/src/ConfigMap.ts:81

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 packages/variable-util/src/ConfigMap.ts:117

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 packages/variable-util/src/ConfigMap.ts:166

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 packages/variable-util/src/ConfigMap.ts:148

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 packages/variable-util/src/ConfigMap.ts:185

read

read<K extends string | number | symbol>(lookupKey: K): Data[K]
Read the cached configuration value for the given key. (use ensure to load/reload the value first)
Type Parameters
- K extends string | number | symbol
  The type of the key to look up in the configuration schema.
Parameters
- lookupKey: K
Returns Data[K]
- The cached configuration value.
Throws
- If the key is not cached, indicating that ensure was not called first.
- Defined in packages/variable-util/src/ConfigMap.ts:252

readObject

readObject<Key extends string | number | symbol = keyof Data>(
key: Key,
): LoaderTypeValueStrict<Data[Key]>
Read the cached configuration value for the given key. (use ensure to load/reload the value first)
Type Parameters
- Key extends string | number | symbol = keyof Data
Parameters
- key: Key
Returns LoaderTypeValueStrict<Data[Key]>
- The cached configuration entry.
Throws
- If the key is not cached, indicating that ensure was not called first.
- Defined in packages/variable-util/src/ConfigMap.ts:223

readObjectResult

readObjectResult<Key extends string | number | symbol = keyof Data>(
key: Key,
): IResult<LoaderTypeValueStrict<Data[Key]>>
Read the cached configuration value for the given key as a Result. (use ensure to load/reload the value first)
Type Parameters
- Key extends string | number | symbol = keyof Data
  The type of the key to look up in the configuration schema.
Parameters
- key: Key
  The key to look up in the configuration schema.
Returns IResult<LoaderTypeValueStrict<Data[Key]>>
- The cached configuration entry wrapped in a Result.
- Defined in packages/variable-util/src/ConfigMap.ts:237

readResult

readResult<K extends string | number | symbol>(
lookupKey: K,
): IResult<Data[K], VariableLookupError>
Read the cached configuration value for the given key as a Result. (use ensure to load/reload the value first)
Type Parameters
- K extends string | number | symbol
  The type of the key to look up in the configuration schema.
Parameters
- lookupKey: K
Returns IResult<Data[K], VariableLookupError>
- The cached configuration value wrapped in a Result.
- Defined in packages/variable-util/src/ConfigMap.ts:262

readString

readString<K extends string | number | symbol>(lookupKey: K): string
Read the cached configuration value as a string for the given key. (use ensure to load/reload the value first)
Type Parameters
- K extends string | number | symbol
  The type of the key to look up in the configuration schema.
Parameters
- lookupKey: K
  The key to look up in the configuration schema.
Returns string
- The cached string value.
Throws
- If the key is not cached, indicating that ensure was not called first.
- Defined in packages/variable-util/src/ConfigMap.ts:279

readStringResult

readStringResult<K extends string | number | symbol>(
lookupKey: K,
): IResult<string, VariableLookupError>
Read the cached configuration value as a string for the given key. (use ensure to load/reload the value first)
Type Parameters
- K extends string | number | symbol
  The type of the key to look up in the configuration schema.
Parameters
- lookupKey: K
  The key to look up in the configuration schema.
Returns IResult<string, VariableLookupError>
- The cached string value wrapped in a Result.
- Defined in packages/variable-util/src/ConfigMap.ts:289

setLogger

setLogger(logger: ILoggerLike | undefined): void
Set logger value
Parameters
- logger: ILoggerLike | undefined
  logger like object
Returns void
- Defined in packages/variable-util/src/ConfigMap.ts:68

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 packages/variable-util/src/ConfigMap.ts:355

Class ConfigMap<Data>

Example

Since

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ConfigMap<Data>

Methods

ensure

Parameters

Returns Promise<IResult<void>>

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

read

Type Parameters

Parameters

Returns Data[K]

Throws

readObject

Type Parameters

Parameters

Returns LoaderTypeValueStrict<Data[Key]>

Throws

readObjectResult

Type Parameters

Parameters

Returns IResult<LoaderTypeValueStrict<Data[Key]>>

readResult

Type Parameters

Parameters

Returns IResult<Data[K], VariableLookupError>

readString

Type Parameters

Parameters

Returns string

Throws

readStringResult