Class default

The make event command to create a class based event

Hierarchy (View Summary)

BaseCommand
- default

Index

Constructors

Properties

commandName description options name app kernel

Accessors

staysAlive startApp

Methods

run createCodemods prepare? interact? completed? exec terminate

Constructors

constructor

new default(
    app: ApplicationService,
    kernel: Kernel,
    parsed: ParsedOutput,
    ui: {},
    prompt: Prompt,
): default
Parameters
- app: ApplicationService
- kernel: Kernel
- parsed: ParsedOutput
- ui: {}
- prompt: Prompt
Returns default
Inherited from BaseCommand.constructor
- Defined in modules/ace/commands.ts:31

Properties

`Static`commandName

commandName: string = 'make:event'

The command name one can type to run the command

`Static`description

description: string = 'Create a new event class'

The command description

`Static`options

options: CommandOptions = ...

Configuration options accepted by the command

name

name: string

app

app: ApplicationService

kernel

kernel: Kernel

Accessors

staysAlive

get staysAlive(): undefined | boolean
Returns undefined | boolean
Inherited from BaseCommand.staysAlive
- Defined in modules/ace/commands.ts:23

startApp

get startApp(): undefined | boolean
Returns undefined | boolean
Inherited from BaseCommand.startApp
- Defined in modules/ace/commands.ts:27

Methods

run

run(): Promise<void>
The run method should include the implementation for the command.

Returns Promise<void>
Example
```
async run() {
  this.logger.info('Running my command')
  return 'Command completed'
}
```
Overrides BaseCommand.run
- Defined in commands/make/event.ts:33

createCodemods

createCodemods(): Promise<Codemods>
Creates the codemods module to modify source files

Returns Promise<Codemods>
Inherited from BaseCommand.createCodemods
- Defined in modules/ace/commands.ts:44

`Optional`prepare

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
Inherited from BaseCommand.prepare
- Defined in modules/ace/commands.ts:59

`Optional`interact

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
Inherited from BaseCommand.interact
- Defined in modules/ace/commands.ts:66

`Optional`completed

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
Inherited from BaseCommand.completed
- Defined in modules/ace/commands.ts:76

exec

exec(): Promise<any>
Executes the lifecycle hooks and the run method from the command

Returns Promise<any>
Inherited from BaseCommand.exec
- Defined in modules/ace/commands.ts:81

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>
Inherited from BaseCommand.terminate
- Defined in modules/ace/commands.ts:123