Program | @jib/cli

Main program registry

Hierarchy

Program

Index

Constructors

constructor

Properties

root

Accessors

Methods

Constructors

constructor

new Program(options?: IProgramOptions): Program

- Defined in program.ts:40
Create the program executor

Parameters
- Default value options: IProgramOptions = {}
  
  program options for command handling
Returns Program

Properties

root

root: Collector

Accessors

config

config:

getter for the resolved configuration

version

version:

get the version specified for the program

Methods

exec

exec(argv: string[], path?: string[]): Promise<void>

- Defined in program.ts:185
execute the argv against the registered commands

Parameters
- argv: string[]
  
  argv as passthrough to the command collector
- Default value path: string[] = []
  
  command invocation path
Returns Promise<void>

globalHelp

globalHelp(heading: string, body?: string, raw?: boolean): Program

- Defined in program.ts:163
Add help text to the main program

Parameters
- heading: string
  
  Add ui heading
- Optional body: string
  
  Help text to show
- Optional raw: boolean
  
  Flag to output the raw text without formatting
Returns Program

globalOption

globalOption<T>(option: ICommandOption, cb?: IProgramOptionCallback<T>): Program

- Defined in program.ts:141
Add an option to the main program

Type parameters
- T
Parameters
- option: ICommandOption
  
  option configuration object
- Optional cb: IProgramOptionCallback<T>
  
  optional callback when value is captured
Returns Program

help

help(collector?: Collector): void

- Defined in program.ts:224
output help text

Parameters
- Optional collector: Collector
Returns void

registerCommand

registerCommand(tree: string[], ctor?: ICommandCtor, subcommands?: ICommandDefinition[]): Collector

- Defined in program.ts:104
register a resolved command by its name and constructor

Parameters
- tree: string[]
- Optional ctor: ICommandCtor
  
  the instance contstructor
- Optional subcommands: ICommandDefinition[]
  
  Subcommands of the parent. If zero-length array, it is assumed subcommands exist so '' will be used
Returns Collector

registerCommandHelp

registerCommandHelp(names: string[], ctor?: ICommandCtor, subcommands?: ICommandDefinition[]): Collector

- Defined in program.ts:80
Register a command for help context

Parameters
- names: string[]
  
  the command names (hierarchy) to be registered
- Optional ctor: ICommandCtor
  
  the command implementation constructor
- Optional subcommands: ICommandDefinition[]
Returns Collector

registerRoot

registerRoot(ctor?: ICommandCtor): Collector

- Defined in program.ts:91
Register a class as the handler for the root command

Parameters
- Optional ctor: ICommandCtor
  
  The root command "default" implementation
Returns Collector