Class OptionBuilder

Wrapper around the

See

Option class, for more intuitive construction.

Remarks

Options are one of boolean, negated, required argument, or optional argument.

Hierarchy

OptionBuilder

Index

Constructors

Properties

Accessors

get hasParser hasValidators parser validator

Methods

choices conflicts default description env hidden hideHelp implies mandatory preset short

Constructors

constructor

new OptionBuilder(cmd, flags): OptionBuilder
Parameters
- cmd: CommandBuilder<unknown[], OptionValues>
- flags: string
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:17

Properties

`Readonly` $

$: Option<"", undefined, undefined, undefined, false, undefined>

`Readonly` cmd

cmd: CommandBuilder<unknown[], OptionValues>

Accessors

get

get get(): OptionReader
Returns OptionReader
- Defined in packages/cli/src/opt/OptionBuilder.ts:88

hasParser

get hasParser(): boolean
Returns boolean
- Defined in packages/cli/src/opt/OptionBuilder.ts:26

hasValidators

get hasValidators(): boolean
Returns boolean
- Defined in packages/cli/src/opt/OptionBuilder.ts:23

parser

get parser(): OptionArgumentParserSelector
Returns OptionArgumentParserSelector
- Defined in packages/cli/src/opt/OptionBuilder.ts:76

validator

get validator(): OptionArgumentValidatorSelector
Returns OptionArgumentValidatorSelector
- Defined in packages/cli/src/opt/OptionBuilder.ts:82

Methods

choices

choices(values): OptionBuilder
Parameters
- values: readonly string[]
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:53

conflicts

conflicts(names): OptionBuilder
Parameters
- names: string | string[]
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:60

default

default(value, description?): OptionBuilder
Parameters
- value: unknown
- Optional description: string
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:49

description

description(string): OptionBuilder
Parameters
- string: string
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:29

env

env(name): OptionBuilder
Parameters
- name: string
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:68

hidden

hidden(hidden?): OptionBuilder
Parameters
- hidden: boolean = true
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:41

hideHelp

hideHelp(hide?): OptionBuilder
Parameters
- hide: boolean = true
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:37

implies

implies(optionValues): OptionBuilder
Parameters
- optionValues: OptionValues
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:64

mandatory

mandatory(mandatory?): OptionBuilder
Parameters
- mandatory: boolean = true
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:33

preset

preset(arg): OptionBuilder
Parameters
- arg: unknown
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:45

short

short(short): OptionBuilder
Parameters
- short: string
Returns OptionBuilder
- Defined in packages/cli/src/opt/OptionBuilder.ts:72

Generated using TypeDoc