Interface ShutdownService

Service allowing registration of prioritised tasks to run during CLI shutdown.

interface ShutdownService {
    isShutdownRequested: boolean;
    enterLongRunningMode(): void;
    interrupt(): void;
    leaveLongRunningMode(): void;
    registerTask(task: ShutdownTask): void;
}

Index

Properties

isShutdownRequested

Methods

enterLongRunningMode interrupt leaveLongRunningMode registerTask

Properties

`Readonly`isShutdownRequested

isShutdownRequested: boolean

True once shutdown has been requested (e.g. first Ctrl-C in long-running mode).

Methods

enterLongRunningMode

enterLongRunningMode(): void
Enter long-running mode where the first Ctrl-C sets a cooperative flag instead of exiting, and a third Ctrl-C forces exit.

Returns void
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/ShutdownService.ts:38

interrupt

interrupt(): void
Handle a user interrupt (e.g. Ctrl-C read as a key press while the terminal is in raw mode), with the same behavior as receiving SIGINT: outside long-running mode, run the shutdown tasks and exit; in long-running mode, set isShutdownRequested, with a third interrupt forcing exit.

Returns void
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/ShutdownService.ts:51

leaveLongRunningMode

leaveLongRunningMode(): void
Leave long-running mode, restoring default single Ctrl-C exit behavior.

Returns void
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/ShutdownService.ts:43

registerTask

registerTask(task: ShutdownTask): void
Register a ShutdownTask to run during graceful shutdown.
Parameters
- task: ShutdownTask
Returns void
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/ShutdownService.ts:32