Class BaseCommand

constructor

• new BaseCommand(
      app: ApplicationService,
      kernel: Kernel,
      parsed: ParsedOutput,
      ui: {},
      prompt: Prompt,
  ): BaseCommand

  Parameters

  • app: ApplicationService
  • kernel: Kernel
  • parsed: ParsedOutput
  • ui: {}
  • prompt: Prompt

  Returns BaseCommand

Staticoptions

app

staysAlive

• get staysAlive(): undefined | boolean

  Returns undefined | boolean

startApp

• get startApp(): undefined | boolean

  Returns undefined | boolean

createCodemods

• createCodemods(): Promise<Codemods>

  Creates the codemods module to modify source files

  Returns Promise<Codemods>

Optionalprepare

• prepare?(..._: any[]): any

  The prepare template method is used to prepare the state for the command. This is the first method executed on a given command instance.

  Parameters

  • ..._: any[]

  Returns any

Optionalinteract

• interact?(..._: any[]): any

  The interact template method is used to display the prompts to the user. The method is called after the prepare method.

  Parameters

  • ..._: any[]

  Returns any

Optionalcompleted

• completed?(..._: any[]): any

  The completed method is the method invoked after the command finishes or results in an error.

  You can access the command error using the this.error property. Returning true from completed method supresses the error reporting to the kernel layer.

  Parameters

  • ..._: any[]

  Returns any

exec

• exec(): Promise<any>

  Executes the lifecycle hooks and the run method from the command

  Returns Promise<any>

terminate

• terminate(): Promise<void>

  Terminate the app. A command should prefer calling this method over the "app.terminate", because this method only triggers app termination when the current command is in the charge of the process.

  Returns Promise<void>