Class Flags

Flags definition and parse

Hierarchy

Flags

Implements

Iterable<FlagDefine<any>>

Index

Constructors

Properties

arrs_? cmd long_? short_?

Methods

_getArrs add bigint bigints bool bools number numbers string strings

Constructors

`Private` constructor

new Flags(cmd: Command): Flags
Parameters
- cmd: Command
Returns Flags
- Defined in src/mod.ts:530

Properties

`Private` `Optional` arrs_

arrs_?: FlagDefine<any>[]

`Private` cmd

`Private` `Optional` long_

long_?: Map<string, FlagDefine<any>>

`Private` `Optional` short_

short_?: Map<string, FlagDefine<any>>

Methods

`Private` _getArrs

_getArrs(): undefined | FlagDefine<any>[]
Returns undefined | FlagDefine<any>[]
- Defined in src/mod.ts:555

add

add(...flags: FlagDefine<any>[]): void
Define flags
Parameters
- Rest ...flags: FlagDefine<any>[]
Returns void
- Defined in src/mod.ts:602

bigint

bigint(opts: FlagOptionsLike<bigint>): FlagBigint
Define a flag of type bigint
Parameters
- opts: FlagOptionsLike<bigint>
Returns FlagBigint
- Defined in src/mod.ts:675

bigints

bigints(opts: FlagOptionsLike<bigint[]>): FlagBigints
Define a flag of type Array
Parameters
- opts: FlagOptionsLike<bigint[]>
Returns FlagBigints
- Defined in src/mod.ts:683

bool

bool(opts: FlagOptionsLike<boolean>): FlagBoolean
Define a flag of type boolean
Parameters
- opts: FlagOptionsLike<boolean>
Returns FlagBoolean
- Defined in src/mod.ts:691

bools

bools(opts: FlagOptionsLike<boolean[]>): FlagBooleans
Define a flag of type Array
Parameters
- opts: FlagOptionsLike<boolean[]>
Returns FlagBooleans
- Defined in src/mod.ts:699

number

number(opts: FlagOptionsLike<number>): FlagNumber
Define a flag of type number
Parameters
- opts: FlagOptionsLike<number>
Returns FlagNumber
- Defined in src/mod.ts:659

numbers

numbers(opts: FlagOptionsLike<number[]>): FlagNumbers
Define a flag of type Array
Parameters
- opts: FlagOptionsLike<number[]>
Returns FlagNumbers
- Defined in src/mod.ts:667

string

string(opts: FlagOptionsLike<string>): FlagString
Define a flag of type string
Parameters
- opts: FlagOptionsLike<string>
Returns FlagString
- Defined in src/mod.ts:643

strings

strings(opts: FlagOptionsLike<string[]>): FlagStrings
Define a flag of type Array
Parameters
- opts: FlagOptionsLike<string[]>
Returns FlagStrings
- Defined in src/mod.ts:651

Generated using TypeDoc