Function getConfigObjectResult

getConfigObjectResult<Output>(
    rootKey: string,
    loaders: IConfigLoader[],
    parser: IConfigParser<Output, unknown>,
    defaultValueLoadable: Loadable<Output>,
    params?: FormatParameters,
    options?: ConfigOptions,
): Promise<IResult<{ type: string | undefined; value: Output }>>
Wrapper around getConfigObject that returns a Result
Type Parameters
- Output
Parameters
- rootKey: string
  root key of config object
- loaders: IConfigLoader[]
  array of loaders
- parser: IConfigParser<Output, unknown>
  parser for value
- defaultValueLoadable: Loadable<Output>
  optional default value
- Optionalparams: FormatParameters
  optional format parameters
- Optionaloptions: ConfigOptions
Returns Promise<IResult<{ type: string | undefined; value: Output }>>
Example
```
// from "@avanio/variable-util-node"
const fileEnv = new FileConfigLoader({fileName: './settings.json', type: 'json'}).getLoader;
const portConfig: Result<{type: string | undefined; value: string}> = await getConfigObject('PORT', [env(), fileEnv()], stringParser, '8080', {showValue: true});
if ( portConfig.isOk() ) {
  const {value, type} = portConfig.unwrap();
} else {
  // handle error
}
```
- Defined in src/getConfigObjectResult.ts:25
getConfigObjectResult<Output>(
    rootKey: string,
    loaders: IConfigLoader[],
    parser: IConfigParser<Output, unknown>,
    defaultValueLoadable?: Loadable<Output>,
    params?: FormatParameters,
    options?: ConfigOptions,
): Promise<IResult<{ type: string | undefined; value: Output | undefined }>>
Wrapper around getConfigObject that returns a Result
Type Parameters
- Output
Parameters
- rootKey: string
  root key of config object
- loaders: IConfigLoader[]
  array of loaders
- parser: IConfigParser<Output, unknown>
  parser for value
- OptionaldefaultValueLoadable: Loadable<Output>
  optional default value
- Optionalparams: FormatParameters
  optional format parameters
- Optionaloptions: ConfigOptions
Returns Promise<IResult<{ type: string | undefined; value: Output | undefined }>>
Example
```
// from "@avanio/variable-util-node"
const fileEnv = new FileConfigLoader({fileName: './settings.json', type: 'json'}).getLoader;
const portConfig: Result<{type: string | undefined; value: string}> = await getConfigObject('PORT', [env(), fileEnv()], stringParser, '8080', {showValue: true});
if ( portConfig.isOk() ) {
  const {value, type} = portConfig.unwrap();
} else {
  // handle error
}
```
- Defined in src/getConfigObjectResult.ts:33

Function getConfigObjectResult

Type Parameters

Parameters

Returns Promise<IResult<{ type: string | undefined; value: Output }>>

Example

Type Parameters

Parameters

Returns Promise<IResult<{ type: string | undefined; value: Output | undefined }>>

Example

Settings