seniority/rc

import rc from 'seniority/rc';
import { parse, rc } from 'seniority/rc';

FunctionsCopy Anchor Link

defaultCopy Anchor Link

The default export, declared as rc.

rc, with its world as an argument.

function rc(name: string, defaults?: RcConfig | string, argv?: RcConfig, parseWith?: RcParse, options?: RcOptions): RcConfig;

Returns RcConfig

module.exportsCopy Anchor Link

What require() returns: the default export, rc, under the name Node's require(esm) reads.

parseCopy Anchor Link

rc's own cc.parse: a document starting with { is JSON — comments allowed — and anything else is INI, which this package does not bundle a parser for (constraint 3). The refusal names parse, rc's fourth parameter, so supplying ini.parse is one argument.

function parse(content: string): RcConfig;

Returns RcConfig

rcCopy Anchor Link

rc, with its world as an argument.

function rc(name: string, defaults?: RcConfig | string, argv?: RcConfig, parseWith?: RcParse, options?: RcOptions): RcConfig;

Returns RcConfig

InterfacesCopy Anchor Link

RcOptionsCopy Anchor Link

The world, as an argument (R11). Every field has a default that touches no process: cwd resolves the empty path, home asks os, and env is empty — because guessing an environment is worse than not having one, which is the call seniority/dotenv already makes for processEnv.

interface RcOptions {
    /** The environment to read `<NAME>_*` from; the process's own when omitted, as rc does (D-135). */
    env?: Record<string, string | undefined>;
    /** Where the upward walk for `.<name>rc` starts. */
    cwd?: string;
    /** The home directory the four `~` places hang off. */
    home?: string;
    /** Skip the `/etc` places, as rc does on Windows — and, as rc, by default only there. */
    win?: boolean;
}

TypesCopy Anchor Link

RcConfigCopy Anchor Link

A parsed config document. rc places no shape on it, and neither does this.

type RcConfig = Record<string, unknown>;

RcParseCopy Anchor Link

rc's fourth parameter: turn a file's text into an object.

type RcParse = (content: string) => RcConfig;