Class CCliCommand<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>

A @carnesen/cli command-line interface (CLI) command

Type parameters

PositionalArgGroup_: CCliArgGroup
NamedArgGroups_: {}
DoubleDashArgGroup_: CCliArgGroup

Hierarchy

CCliCommand

Index

Constructors

constructor

Properties

options

Accessors

Methods

Constructors

Protected constructor

new CCliCommand(options: CCliCommandOptions<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>): CCliCommand

- Defined in src/c-cli-command.ts:81
Parameters
- options: CCliCommandOptions<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>
Returns CCliCommand

Properties

Protected options

options: CCliCommandOptions<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>

Accessors

description

get description(): CCliDescription

- Defined in src/c-cli-command.ts:100
Returns CCliDescription

doubleDashArgGroup

get doubleDashArgGroup(): DoubleDashArgGroup_ | undefined

- Defined in src/c-cli-command.ts:104
Returns DoubleDashArgGroup_ | undefined

hidden

get hidden(): boolean

- Defined in src/c-cli-command.ts:108
Returns boolean

name

get name(): string

- Defined in src/c-cli-command.ts:112
Returns string

namedArgGroups

get namedArgGroups(): NamedArgGroups_ | undefined

- Defined in src/c-cli-command.ts:116
Returns NamedArgGroups_ | undefined

positionalArgGroup

get positionalArgGroup(): PositionalArgGroup_ | undefined

- Defined in src/c-cli-command.ts:120
Returns PositionalArgGroup_ | undefined

Methods

action

action(input: CCliCommandActionInput<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>): any

- Defined in src/c-cli-command.ts:90
Parameters
- input: CCliCommandActionInput<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>
Returns any

Static create

create<PositionalArgGroup, NamedArgGroups, DoubleDashArgGroup>(options: CCliCommandOptions<PositionalArgGroup, NamedArgGroups, DoubleDashArgGroup>): CCliCommand<PositionalArgGroup, NamedArgGroups, DoubleDashArgGroup>

- Defined in src/c-cli-command.ts:125
Factory for @carnesen/cli command-line interface (CLI) commands

Type parameters
- PositionalArgGroup: CCliArgGroup
- NamedArgGroups: {}
- DoubleDashArgGroup: CCliArgGroup
Parameters
- options: CCliCommandOptions<PositionalArgGroup, NamedArgGroups, DoubleDashArgGroup>
Returns CCliCommand<PositionalArgGroup, NamedArgGroups, DoubleDashArgGroup>

Generated using TypeDoc and MonoLisa