Function getConfigVariable

  • getConfigVariable<Output>(
        rootKey: string,
        loaders: IConfigLoader[],
        parser: IConfigParser<Output, unknown>,
        defaultValueLoadable: Loadable<Output>,
        params?: FormatParameters,
        options?: ConfigOptions,
        encodeOptions?: EncodeOptions,
    ): Promise<Output>

  • get config variable from loaders

    Type Parameters

    • Output

    Parameters

    Returns Promise<Output>

    Example

    // from "@avanio/variable-util-node"
    const fileEnv = new FileConfigLoader({fileName: './settings.json', type: 'json'}).getLoader;

    const port: Promise<string> = await getConfigVariable('PORT', [env(), fileEnv()], stringParser, '8080', {showValue: true});
    // with override key
    const port: Promise<string> = await getConfigVariable('PORT', [env('HTTP_PORT', fileEnv())], stringParser, '8080', {showValue: true});
  • getConfigVariable<Output>(
        rootKey: string,
        loaders: IConfigLoader[],
        parser: IConfigParser<Output, unknown>,
        defaultValueLoadable?: Loadable<Output>,
        params?: FormatParameters,
        options?: ConfigOptions,
        encodeOptions?: EncodeOptions,
    ): Promise<Output | undefined>

  • get config variable from loaders

    Type Parameters

    • Output

    Parameters

    Returns Promise<Output | undefined>

    Example

    // from "@avanio/variable-util-node"
    const fileEnv = new FileConfigLoader({fileName: './settings.json', type: 'json'}).getLoader;

    const port: Promise<string> = await getConfigVariable('PORT', [env(), fileEnv()], stringParser, '8080', {showValue: true});
    // with override key
    const port: Promise<string> = await getConfigVariable('PORT', [env('HTTP_PORT', fileEnv())], stringParser, '8080', {showValue: true});

Settings

Member Visibility