Function getConfigVariableResult

getConfigVariableResult<Output>(
    rootKey: string,
    loaders: IConfigLoader[],
    parser: IConfigParser<unknown, Output>,
    defaultValueLoadable?: Loadable<Output>,
    params?: FormatParameters,
    options?: ConfigOptions,
): Promise<IResult<Output>>
get config variable from loaders
Type Parameters
- Output
  Type of output
Parameters
- rootKey: string
  root key of config variable
- loaders: IConfigLoader[]
  loaders to use
- parser: IConfigParser<unknown, Output>
  parser to use
- OptionaldefaultValueLoadable: Loadable<Output>
  default value to use
- Optionalparams: FormatParameters
  optional format parameters
- Optionaloptions: ConfigOptions
  optional config options
Returns Promise<IResult<Output>>
- result with value or error
Example
```
// from "@avanio/variable-util-node"
const portResult: Result<string> = await getConfigVariableResult('PORT', [env(), fileEnv()], stringParser, '8080', {showValue: true});

const value: string = portResult.unwrap(); //  get value or throw error
const value: string | undefined = portResult.ok(); //  get value or undefined
```
Since
v1.0.0
- Defined in src/getConfigVariableResult.ts:26
getConfigVariableResult<Output>(
    rootKey: string,
    loaders: IConfigLoader[],
    parser: IConfigParser<unknown, Output>,
    defaultValueLoadable?: Loadable<Output>,
    params?: FormatParameters,
    options?: ConfigOptions,
): Promise<IResult<undefined | Output>>
get config variable from loaders
Type Parameters
- Output
  Type of output
Parameters
- rootKey: string
  root key of config variable
- loaders: IConfigLoader[]
  loaders to use
- parser: IConfigParser<unknown, Output>
  parser to use
- OptionaldefaultValueLoadable: Loadable<Output>
  default value to use
- Optionalparams: FormatParameters
  optional format parameters
- Optionaloptions: ConfigOptions
  optional config options
Returns Promise<IResult<undefined | Output>>
- result with value or error
Example
```
// from "@avanio/variable-util-node"
const portResult: Result<string> = await getConfigVariableResult('PORT', [env(), fileEnv()], stringParser, '8080', {showValue: true});

const value: string = portResult.unwrap(); //  get value or throw error
const value: string | undefined = portResult.ok(); //  get value or undefined
```
Since
v1.0.0
- Defined in src/getConfigVariableResult.ts:34

Function getConfigVariableResult

Type Parameters

Parameters

Returns Promise<IResult<Output>>

Example

Since

Type Parameters

Parameters

Returns Promise<IResult<undefined | Output>>

Example

Since

Settings