Option | dark

Initialize a new Option with the given flags and description.

param
param

Hierarchy

Option

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Option(flags: string, description: string): Option

- Defined in option.ts:36
Parameters
- flags: string
- description: string
Returns Option

Properties

bool

bool: boolean

defaultValue

defaultValue: string

description

description: string

flags

flags: string

long

long: string

optional

optional: boolean

required

required: boolean

short

short: string

Methods

arity

arity(): number

- Defined in option.ts:78
Returns number of args that are expected by the option. Can only be 0 or 1.

Returns number

attributeName

attributeName(): string

- Defined in option.ts:62
Return option name, in a camelcase format that can be used as a object attribute key.

Returns string

is

is(arg: string): boolean

- Defined in option.ts:70
Check if arg matches the short or long flag. Internally used to check if an arg belongs to an Option

Parameters
- arg: string
Returns boolean

name

name(): string

- Defined in option.ts:54
Return option name.

Returns string

Generated using TypeDoc