read-config-file

Install

npm i read-config-file

yarn add read-config-file

pnpm add read-config-file

Read configuration file in various formats:

findAndReadConfig: <T>(
    request: ReadConfigRequest
) => Promise<ReadConfigResult<T> | null>;

getConfig: <T>(
    request: ReadConfigRequest,
    configPath?: string | null
) => Promise<ReadConfigResult<T> | null>;

loadConfig: <T>(
    request: ReadConfigRequest
) => Promise<ReadConfigResult<T> | null>;

loadEnv: (envFile: string) => Promise<import('dotenv').DotenvParseOutput | null>;

loadParentConfig: <T>(
    request: ReadConfigRequest,
    spec: string
) => Promise<ReadConfigResult<T>>;

orIfFileNotExist: <T>(promise: Promise<T>, fallbackValue: T) => Promise<T>;

orNullIfFileNotExist: <T>(promise: Promise<T>) => Promise<T | null>;

interface ReadConfigRequest {}

configFilename: string;

packageKey: string;

packageMetadata: Lazy<{
    [key: string]: any;
} | null> | null;

projectDir: string;

interface ReadConfigResult<T> {}

readonly configFile: string | null;

readonly result: T;

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/read-config-file.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/read-config-file)

HTML

<a href="https://www.jsdocs.io/package/read-config-file"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>