Interface IConfigLoader

Interface for config loaders

Since

v1.0.0

interface IConfigLoader {
    loaderType: Lowercase<string>;
    getLoaderResult(
        lookupKey: string,
    ): LoaderValueResult | Promise<LoaderValueResult | undefined> | undefined;
    isLoaderDisabled(): boolean | Promise<boolean | undefined> | undefined;
}

Implemented by

ConfigLoader

Index

Properties

Methods

getLoaderResult isLoaderDisabled

Properties

`Readonly`loaderType

loaderType: Lowercase<string>

this is shown on logs ConfigVariables[___type___]: KEY [VALUE] from {path}

Methods

getLoaderResult

getLoaderResult(
lookupKey: string,
): LoaderValueResult | Promise<LoaderValueResult | undefined> | undefined
get loader result for lookupKey
Parameters
- lookupKey: string
  key to lookup
Returns LoaderValueResult | Promise<LoaderValueResult | undefined> | undefined
- Promise of LoaderValueResult or undefined
- Defined in packages/variable-util/src/interfaces/IConfigLoader.ts:31

isLoaderDisabled

isLoaderDisabled(): boolean | Promise<boolean | undefined> | undefined
Check if loader is disabled

Returns boolean | Promise<boolean | undefined> | undefined
- Promise of boolean or undefined
- Defined in packages/variable-util/src/interfaces/IConfigLoader.ts:36