Skip to content

Latest commit

 

History

History
141 lines (83 loc) · 2.44 KB

File metadata and controls

141 lines (83 loc) · 2.44 KB

Table of contents

Type aliases

Variables

Functions

Type aliases

Arguments

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

Type parameters

Name Type
T {}

Defined in

node_modules/@types/yargs/index.d.ts:646


Context

Ƭ Context: Object

Type declaration

Name Type
parse Parser
program Program

Defined in

src/index.ts:16


Parser

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

Type declaration

▸ (argv?): Promise<Arguments>

Parameters
Name Type
argv? string[]
Returns

Promise<Arguments>

Defined in

src/index.ts:14


Program

Ƭ Program: Argv

Defined in

src/index.ts:12

Variables

GIT_COMMITMSG_PATH

Const GIT_COMMITMSG_PATH: "./.git/COMMIT_EDITMSG"

Defined in

src/index.ts:24

Functions

configureProgram

configureProgram(): Context

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

Returns

Context

Defined in

src/index.ts:67

configureProgram(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:73