"src/command" | typed-cli

Index

Classes

CommandBuilder

Type aliases

Variables

defaultCommand

Functions

Type aliases

CommandHelperParams

CommandHelperParams: object

Type declaration

CreateCommandHelperParams

CreateCommandHelperParams: object

Type declaration

ParseCommandSetParams

ParseCommandSetParams: object

Type declaration

Variables

Const defaultCommand

defaultCommand: unique symbol = Symbol('defaultCommand')

It can be used as a key in command set to set a default command. Such command will be used if no command was provided.

Functions

command

command<D>(decl: D): CommandBuilder<D>

- Defined in src/command.ts:298
Defines a program command

Type parameters
- D: CliDeclaration
Parameters
- decl: D
  
  command declaration, which is basicly the same as program declaration passed to cli()
Returns CommandBuilder<D>

Const createCommandHelper

createCommandHelper(params: CreateCommandHelperParams): (Anonymous function)

- Defined in src/command.ts:239
Creates a CommandHelper. cli.command - is an example of CommandHelper created with this function.

Parameters
- params: CreateCommandHelperParams
Returns (Anonymous function)

Generated using TypeDoc