abstractCommand <O, P, Options>

Hierarchy

• CommandManager<Options>
  • Command

Implements

• Commandable<O, P>

Index

Events

• onAfterRegister
• onBeforeRegister

Other

• constructor
• exit
• help
• locale
• log
• options
• rest
• unknown
• version
• aliases
• allowUnknownOptions
• allowVariadicParams
• categories
• category
• deprecated
• description
• hidden
• options
• params
• path
• usage
• blueprint
• configure
• createHelp
• executeCommand
• getArguments
• getCommand
• getCommandPaths
• getMetadata
• getParserOptions
• getPath
• register
• render
• run
• runProgram
• runTask

Events

readonlyonAfterRegister

onAfterRegister: Event<[string, Commandable<any, any[]>], string> = ...

Inherited from CommandManager.onAfterRegister

Called after a command has been registered.

readonlyonBeforeRegister

onBeforeRegister: Event<[string, Commandable<any, any[]>], string> = ...

Inherited from CommandManager.onBeforeRegister

Called before a command has been registered.

Other

constructor

• new Command<O, P, Options>(options?: Options): Command<O, P, Options>

• Overrides CommandManager<Options>.constructor

  Type parameters

  • O: GlobalOptions = GlobalOptions
  • P: PrimitiveType[] = ArgList
  • Options: object = {}

exit

exit: ExitHandler

Method to exit the current program, with an optional error code.

help

help: boolean = false

Value of --help, -h passed on the command line.

locale

locale: string = 'en'

Value of --locale passed on the command line.

log

log: LoggerFunction

Method to log to the console using a log level.

readonlyoptions

options: Readonly<Required<Options>>

Inherited from CommandManager.options

Validated and configured options.

rest

rest: string[] = []

Additional arguments passed after -- on the command line.

unknown

unknown: UnknownOptionMap = {}

Unknown options passed on the command line.

version

version: boolean = false

Value of --version, -v passed on the command line.

staticaliases

aliases: string[] = []

staticallowUnknownOptions

allowUnknownOptions: boolean = false

staticallowVariadicParams

allowVariadicParams: string | boolean = false

staticcategories

categories: Categories = {}

staticcategory

category: string = ''

staticdeprecated

deprecated: boolean = false

staticdescription

description: string = ''

statichidden

hidden: boolean = false

staticoptions

options: OptionConfigMap = globalOptions

staticparams

params: ParamConfigList = []

staticpath

path: string = ''

staticusage

usage: string | string[] = ''

blueprint

• blueprint(schemas: __module): object

• Overrides CommandManager.blueprint

  Validate options passed to the constructor.

configure

• configure(options?: Partial<Options> | (options: Required<Options>) => Partial<Options>): Readonly<Required<Options>>

• Inherited from CommandManager.configure

  Set an options object by merging the new partial and existing options with the defined blueprint, while running all validation checks. Freeze and return the options object.

  object.configure({ name: 'Boost' });
  
  object.configure((prevOptions) => ({
      nestedObject: {
          ...prevOptions.nestedObject,
          some: 'value',
      },
  }));

createHelp

• createHelp(): Promise<ReactElement<any, string | JSXElementConstructor<any>>>

• Implementation of Commandable.createHelp

  Create a React element based on the Help component.

executeCommand

• executeCommand(command: string, args: string[], options?: Options): Promise<ExecaReturnValue<string>>

• Execute a system native command with the given arguments and pass the results through a promise. This does not execute Boost CLI commands, use runProgram() instead.

getArguments

• getArguments(): Arguments<O, P>

• Return the current command class as an arguments object. Options and params must be parsed first to operate correctly.

getCommand

• getCommand<O, P>(path: string): null | Commandable<O, P>

• Inherited from CommandManager.getCommand

  Return a command by registered path, or null if not found.

  ---

  Type parameters

  • O: object = {}
  • P: PrimitiveType[] = ArgList

getCommandPaths

• getCommandPaths(): string[]

• Inherited from CommandManager.getCommandPaths

  Return a list of all registered command paths (including aliases).

getMetadata

• getMetadata(): CommandMetadata

• Implementation of Commandable.getMetadata

  Validate and return all metadata registered to this command instance.

getParserOptions

• getParserOptions(): ParserOptions<O, P>

• Implementation of Commandable.getParserOptions

  Return metadata as options for argument parsing.

getPath

• getPath(): string

• Implementation of Commandable.getPath

  Return the command path (canonical name on the command line).

register

• register(command: Commandable<any, any[]>): this

• Inherited from CommandManager.register

  Register a command and its canonical path (must be unique), otherwise an error is thrown.

render

• render(element: ReactElement<any, string | JSXElementConstructor<any>>): Promise<void>

• Implementation of Commandable.render

  Render a React element with Ink and output to the configured streams.

abstractrun

• run(...params: P): RunResult | Promise<RunResult>

• Implementation of Commandable.run

  Executed when the command is being ran.

runProgram

• runProgram(argv: Argv): Promise<number>

• Run the program within itself, by passing a custom command and argv list.

runTask

• runTask<A, R>(task: (this: TaskContext<O>, ...args: A) => R, ...args: A): R

• Run a task (function) with the defined arguments and the current command instance bound to the task's context.

  ---

  Type parameters

  • A: unknown[]
  • R