Skip to content

ResolveOptions ​

External state the resolver may consult after parsing.

The resolver never reaches into process, files, or terminal APIs directly; callers inject those facts through this contract.

Signatures ​

ts
interface ResolveOptions {}

Members ​

Properties ​

config ​

Parsed config file contents keyed by dotted path segments.

ts
config?: Readonly<Record<string, unknown>>;

env ​

Environment variable snapshot injected by the caller.

ts
env?: Readonly<Record<string, string | undefined>>;

mkdir ​

Recursive directory creation for flag.path() and arg.path() create checks. When absent, missing paths are not created and existence rules apply as-is.

ts
mkdir?: { (path: string): Promise<void>; };

prompter ​

Interactive prompt engine; absent in non-TTY / CI contexts.

ts
prompter?: PromptEngine;

stat ​

Filesystem probe for flag.path() and arg.path() checks: what exists at the path, or null when nothing does. When absent, path checks are skipped.

ts
stat?: { (path: string): Promise<"file" | "directory" | null>; };

stdinData ​

Pre-read stdin content, or null when stdin was not piped.

ts
stdinData?: string | null;

See Also ​

Released under the MIT License.