Function getConfigObjectResult

  • getConfigObjectResult<Output>(rootKey, loaders, parser, defaultValueLoadable, params?, options?): Promise<Result<{
        type: string | undefined;
        value: Output;
    }>>

  • Wrapper around getConfigObject that returns a Result

    Type Parameters

    • Output

    Parameters

    Returns Promise<Result<{
        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
    }
  • getConfigObjectResult<Output>(rootKey, loaders, parser, defaultValueLoadable?, params?, options?): Promise<Result<{
        type: string | undefined;
        value: Output | undefined;
    }>>

  • Type Parameters

    • Output

    Parameters

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

Settings

Member Visibility

Theme