Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CCliCommand<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>

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

Type parameters

Hierarchy

  • CCliCommand

Index

Constructors

Protected constructor

Properties

Protected options

options: CCliCommandOptions<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>

Accessors

description

  • get description(): CCliDescription

doubleDashArgGroup

  • get doubleDashArgGroup(): DoubleDashArgGroup_ | undefined

hidden

  • get hidden(): boolean

name

  • get name(): string

namedArgGroups

  • get namedArgGroups(): NamedArgGroups_ | undefined

positionalArgGroup

  • get positionalArgGroup(): PositionalArgGroup_ | undefined

Methods

action

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

    • input: CCliCommandActionInput<PositionalArgGroup_, NamedArgGroups_, DoubleDashArgGroup_>

    Returns any

Static create

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

Generated using TypeDoc and MonoLisa