Class CancelExitEvent

Hierarchy

ExitEvent
- CancelExitEvent
  - CliParseEvent
  - HelpHelperOnInvalidArgumentsShowHelpEvent

Index

Constructors

constructor

Properties

event

Accessors

cli

Methods

Constructors

constructor

new CancelExitEvent(event?: string | string[]): CancelExitEvent

Inherited from Event.constructor
- Defined in src/core/events.ts:13
Parameters
- Default value event: string | string[] = undefined
Returns CancelExitEvent

Properties

event

event: string | string[]

Accessors

cli

get cli(): Cli

Inherited from Event.cli
- Defined in src/core/events.ts:11
Returns Cli

Methods

Protected cancel

cancel(): void

- Defined in src/core/events.ts:62
Returns void

canceled

canceled(cb: function): this

- Defined in src/core/events.ts:65
Parameters
- cb: function
  - - (): void
    - Returns void
Returns this

exit

exit(code?: number): void

Inherited from ExitEvent.exit
- Defined in src/core/events.ts:23
Parameters
- Default value code: number = 0
Returns void

isCanceled

isCanceled(): boolean

- Defined in src/core/events.ts:77
Returns boolean

proceed

proceed(cb: function): this

- Defined in src/core/events.ts:71
Parameters
- cb: function
  - - (): void
    - Returns void
Returns this

shouldExit

shouldExit(): boolean

Inherited from ExitEvent.shouldExit
- Defined in src/core/events.ts:35
Returns boolean

stopIfExit

stopIfExit(): this

Inherited from ExitEvent.stopIfExit
- Defined in src/core/events.ts:28
Returns this

Generated using TypeDoc