docs

Table of contents

Type aliases

• Arguments
• Context
• Parser
• Program

Functions

• configureProgram

Type aliases

Arguments

Ƭ Arguments<T>: T & { [argName: string]: unknown; $0: string ; _: (string | number)[] }

Type parameters:

Name	Default
T	{}

Defined in: node_modules/@types/yargs/index.d.ts:641

---

Context

Ƭ Context: object

Type declaration:

Name	Type
parse	Parser
program	Program

Defined in: src/index.ts:12

---

Parser

Ƭ Parser: (argv?: string[]) => Promise<Arguments>

Type declaration:

▸ (argv?: string[]): Promise<Arguments>

Parameters:

Name	Type
argv?	string[]

Returns: Promise<Arguments>

Defined in: src/index.ts:10

---

Program

Ƭ Program: Argv

Defined in: src/index.ts:8

Functions

configureProgram

▸ configureProgram(): Context

Create and return a pre-configured Yargs instance (program) and argv parser.

Returns: Context

Defined in: src/index.ts:23

▸ configureProgram(program: Program): Context

Configure an existing Yargs instance (program) and return an argv parser.

Parameters:

Name	Type	Description
program	Program	A Yargs instance to configure

Returns: Context

Defined in: src/index.ts:29