Command | cac

Hierarchy

Command
- GlobalCommand

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Command(rawName: string, description: string, config?: CommandConfig, cli: CAC): Command

- Defined in src/Command.ts:43
Parameters
- rawName: string
- description: string
- Default value config: CommandConfig = {}
- cli: CAC
Returns Command

Properties

aliasNames

aliasNames: string[]

args

args: CommandArg[]

cli

cli: CAC

Optional commandAction

commandAction: undefined | ((...args: any[]) => any)

config

config: CommandConfig

description

description: string

examples

examples: CommandExample[]

Optional globalCommand

globalCommand: GlobalCommand

Optional helpCallback

helpCallback: HelpCallback

name

name: string

options

options: Option[]

rawName

rawName: string

Optional usageText

usageText: undefined | string

Optional versionNumber

versionNumber: undefined | string

Accessors

isDefaultCommand

get isDefaultCommand(): boolean

- Defined in src/Command.ts:114
Returns boolean

isGlobalCommand

get isGlobalCommand(): boolean

- Defined in src/Command.ts:118
Returns boolean

Methods

action

action(callback: (...args: any[]) => any): this

- Defined in src/Command.ts:101
Parameters
- callback: (...args: any[]) => any
  - - (...args: any[]): any
    - Parameters
      - Rest ...args: any[]
      Returns any
Returns this

alias

alias(name: string): this

- Defined in src/Command.ts:96
Parameters
- name: string
Returns this

allowUnknownOptions

allowUnknownOptions(): this

- Defined in src/Command.ts:63
Returns this

checkOptionValue

checkOptionValue(): void

- Defined in src/Command.ts:282
Check if the required string-type options exist

Returns void

checkRequiredArgs

checkRequiredArgs(): void

- Defined in src/Command.ts:246
Returns void

checkUnknownOptions

checkUnknownOptions(): void

- Defined in src/Command.ts:261
Check if the parsed options contain any unknown options

Exit and output error when true

Returns void

example

example(example: CommandExample): this

- Defined in src/Command.ts:79
Parameters
- example: CommandExample
Returns this

hasOption

hasOption(name: string): undefined | Option

- Defined in src/Command.ts:126
Check if an option is registered in this command

Parameters
- name: string
  
  Option name
Returns undefined | Option

ignoreOptionDefaultValue

ignoreOptionDefaultValue(): this

- Defined in src/Command.ts:68
Returns this

isMatched

isMatched(name: string): boolean

- Defined in src/Command.ts:110
Check if a command name is matched by this command

Parameters
- name: string
  
  Command name
Returns boolean

option

option(rawName: string, description: string, config?: OptionConfig): this

- Defined in src/Command.ts:90
Add a option for this command

Parameters
- rawName: string
  
  Raw option name(s)
- description: string
  
  Option description
- Optional config: OptionConfig
  
  Option config
Returns this

outputHelp

outputHelp(): void

- Defined in src/Command.ts:133
Returns void

outputVersion

outputVersion(): void

- Defined in src/Command.ts:238
Returns void

usage

usage(text: string): this

- Defined in src/Command.ts:58
Parameters
- text: string
Returns this

version

version(version: string, customFlags?: string): this

- Defined in src/Command.ts:73
Parameters
- version: string
- Default value customFlags: string = "-v, --version"
Returns this

Generated using TypeDoc