Classservicesv0.6.0

CoordinatedShutdown

CoordinatedShutdown manages graceful application shutdown by executing registered tasks across defined phases.

It listens for termination signals (SIGINT, SIGTERM) and runs tasks in parallel within each phase. Tasks can be added or removed dynamically, and each task has an associated timeout.

class CoordinatedShutdown extends CoordinatedLifecycle<
    ShutdownPhase,
    CoordinatedShutdownEvents
>

class CoordinatedShutdown extends CoordinatedLifecycle<
    ShutdownPhase,
    CoordinatedShutdownEvents
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the CoordinatedShutdownCoordinatedShutdown class

CoordinatedShutdown(enabled?: boolean)

CoordinatedShutdown(enabled?: boolean)

Showing members with Protected visibility and higher.

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:CoordinatedLifecycle

phaseEnum

protected readonly phaseEnum: Record<number, string>

protected readonly phaseEnum: Record<number, string>

Inherited from:CoordinatedLifecycle

phaseOrder

protected readonly phaseOrder: TPhase[]

protected readonly phaseOrder: TPhase[]

Inherited from:CoordinatedLifecycle

tasksMap

protected readonly tasksMap: Map<TPhase, LifecycleTask[]>

protected readonly tasksMap: Map<TPhase, LifecycleTask[]>

Inherited from:CoordinatedLifecycle

addListener()

Alias of onon for compatibility with Node.js EventEmitter APIs.

addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

Inherited from:StrictEventEmitter

addTask()

Adds a task to a specific shutdown phase with timeout.

public addTask(
    phase: ShutdownPhase,
    taskName: string,
    task: () => Promise<void>,
    timeoutMs?: number
): void

public addTask(
    phase: ShutdownPhase,
    taskName: string,
    task: () => Promise<void>,
    timeoutMs?: number
): void

Parameter: phase

The shutdown phase from ShutdownPhaseShutdownPhase

Parameter: taskName

Unique identifier for the task

Parameter: task

Async function to execute

Parameter: timeoutMs

Task timeout in milliseconds

canAddTask()

protected canAddTask(): boolean

protected canAddTask(): boolean

canRemoveTask()

protected canRemoveTask(): boolean

protected canRemoveTask(): boolean

emit()

Emits an event with the strictly typed argument tuple for the event name.

emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

Parameter: event

The event name to emit

Parameter: args

Tuple payload for the event

Inherited from:StrictEventEmitter

eventNamesTyped()

Returns the list of event names known to the emitter with the mapped key type.

eventNamesTyped(): SEEventKey<TEvents>[]

eventNamesTyped(): SEEventKey<TEvents>[]

Inherited from:StrictEventEmitter

executeTasksInPhase()

protected async executeTasksInPhase(
    phase: ShutdownPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

protected async executeTasksInPhase(
    phase: ShutdownPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

getTaskType()

protected getTaskType(): string

protected getTaskType(): string

listenerCountTyped()

Counts listeners for an event without widening the return type of listenerCountlistenerCount.

listenerCountTyped<TEventKey>(event: TEventKey): number

listenerCountTyped<TEventKey>(event: TEventKey): number

Parameter: event

The event name to inspect

Inherited from:StrictEventEmitter

listeners()

Retrieves the listener list for a given event with the correct tuple signature.

listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

Parameter: event

The event name to inspect

Inherited from:StrictEventEmitter

off()

Removes a previously registered listener for the given event.

off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

Inherited from:StrictEventEmitter

on()

Registers a persistent listener with tuple-safe arguments for the given event.

on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

Inherited from:StrictEventEmitter

once()

Registers a one time listener that is removed after the first invocation.

once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

Inherited from:StrictEventEmitter

removeListener()

Alias of offoff for compatibility with Node.js EventEmitter APIs.

removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

Inherited from:StrictEventEmitter

removeTask()

Removes a task from a specific shutdown phase.

public removeTask(
    phase: ShutdownPhase,
    taskName: string
): boolean

public removeTask(
    phase: ShutdownPhase,
    taskName: string
): boolean

Parameter: phase

The shutdown phase to remove from

Parameter: taskName

Name of the task to remove

run()

Executes the coordinated shutdown sequence.

Runs all registered tasks across shutdown phases in reverse order. Tasks within each phase are executed in parallel for faster shutdown. Process exits with the specified code when complete.

public async run(
    exitCode?: number,
    exitProcess?: boolean
): Promise<void>

public async run(
    exitCode?: number,
    exitProcess?: boolean
): Promise<void>

Parameter: exitCode

Process exit code

Parameter: exitProcess

Whether to exit the process after shutdown

shutdown.addTask(ShutdownPhase.Services, 'database', () => db.disconnect(), 5000);
await shutdown.run(0); // Graceful shutdown

shutdown.addTask(ShutdownPhase.Services, 'database', () => db.disconnect(), 5000);
await shutdown.run(0); // Graceful shutdown

runPhase()

Run all tasks in a specific phase

protected async runPhase(phase: TPhase): Promise<void>

protected async runPhase(phase: TPhase): Promise<void>

Inherited from:CoordinatedLifecycle

runTaskWithTimeout()

Run a single task with timeout

protected async runTaskWithTimeout(
    phase: TPhase,
    task: LifecycleTask
): Promise<void>

protected async runTaskWithTimeout(
    phase: TPhase,
    task: LifecycleTask
): Promise<void>

Inherited from:CoordinatedLifecycle

waitFor()

Waits for an event to be emitted, resolving with the listener arguments tuple once triggered. Supports optional abort signals and timeouts for cancellation semantics.

async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

Parameter: event

The event name to wait for

Parameter: opts

Optional abort signal or timeout in milliseconds

Inherited from:StrictEventEmitter

Classservicesv0.6.0

CoordinatedShutdown

CoordinatedShutdown manages graceful application shutdown by executing registered tasks across defined phases.

It listens for termination signals (SIGINT, SIGTERM) and runs tasks in parallel within each phase. Tasks can be added or removed dynamically, and each task has an associated timeout.

class CoordinatedShutdown extends CoordinatedLifecycle<
    ShutdownPhase,
    CoordinatedShutdownEvents
>

class CoordinatedShutdown extends CoordinatedLifecycle<
    ShutdownPhase,
    CoordinatedShutdownEvents
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the CoordinatedShutdownCoordinatedShutdown class

CoordinatedShutdown(enabled?: boolean)

CoordinatedShutdown(enabled?: boolean)

Showing members with Protected visibility and higher.

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:CoordinatedLifecycle

phaseEnum

protected readonly phaseEnum: Record<number, string>

protected readonly phaseEnum: Record<number, string>

Inherited from:CoordinatedLifecycle

phaseOrder

protected readonly phaseOrder: TPhase[]

protected readonly phaseOrder: TPhase[]

Inherited from:CoordinatedLifecycle

tasksMap

protected readonly tasksMap: Map<TPhase, LifecycleTask[]>

protected readonly tasksMap: Map<TPhase, LifecycleTask[]>

Inherited from:CoordinatedLifecycle

addListener()

Alias of onon for compatibility with Node.js EventEmitter APIs.

addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

addListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

Inherited from:StrictEventEmitter

addTask()

Adds a task to a specific shutdown phase with timeout.

public addTask(
    phase: ShutdownPhase,
    taskName: string,
    task: () => Promise<void>,
    timeoutMs?: number
): void

public addTask(
    phase: ShutdownPhase,
    taskName: string,
    task: () => Promise<void>,
    timeoutMs?: number
): void

Parameter: phase

The shutdown phase from ShutdownPhaseShutdownPhase

Parameter: taskName

Unique identifier for the task

Parameter: task

Async function to execute

Parameter: timeoutMs

Task timeout in milliseconds

canAddTask()

protected canAddTask(): boolean

protected canAddTask(): boolean

canRemoveTask()

protected canRemoveTask(): boolean

protected canRemoveTask(): boolean

emit()

Emits an event with the strictly typed argument tuple for the event name.

emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

emit<TEventKey>(
    event: TEventKey,
    args: TEvents[TEventKey]
): boolean

Parameter: event

The event name to emit

Parameter: args

Tuple payload for the event

Inherited from:StrictEventEmitter

eventNamesTyped()

Returns the list of event names known to the emitter with the mapped key type.

eventNamesTyped(): SEEventKey<TEvents>[]

eventNamesTyped(): SEEventKey<TEvents>[]

Inherited from:StrictEventEmitter

executeTasksInPhase()

protected async executeTasksInPhase(
    phase: ShutdownPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

protected async executeTasksInPhase(
    phase: ShutdownPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

getTaskType()

protected getTaskType(): string

protected getTaskType(): string

listenerCountTyped()

Counts listeners for an event without widening the return type of listenerCountlistenerCount.

listenerCountTyped<TEventKey>(event: TEventKey): number

listenerCountTyped<TEventKey>(event: TEventKey): number

Parameter: event

The event name to inspect

Inherited from:StrictEventEmitter

listeners()

Retrieves the listener list for a given event with the correct tuple signature.

listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

listeners<TEventKey>(
    event: TEventKey
): ((...args: TEvents[TEventKey]) => void)[]

Parameter: event

The event name to inspect

Inherited from:StrictEventEmitter

off()

Removes a previously registered listener for the given event.

off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

off<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

Inherited from:StrictEventEmitter

on()

Registers a persistent listener with tuple-safe arguments for the given event.

on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

on<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

Inherited from:StrictEventEmitter

once()

Registers a one time listener that is removed after the first invocation.

once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

once<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name to attach to

Parameter: listener

Callback operating on the typed argument tuple for the event

Inherited from:StrictEventEmitter

removeListener()

Alias of offoff for compatibility with Node.js EventEmitter APIs.

removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

removeListener<TEventKey>(
    event: TEventKey,
    listener: (...args: TEvents[TEventKey]) => void
): this

Parameter: event

The event name whose listener should be removed

Parameter: listener

Callback originally registered for the event

Inherited from:StrictEventEmitter

removeTask()

Removes a task from a specific shutdown phase.

public removeTask(
    phase: ShutdownPhase,
    taskName: string
): boolean

public removeTask(
    phase: ShutdownPhase,
    taskName: string
): boolean

Parameter: phase

The shutdown phase to remove from

Parameter: taskName

Name of the task to remove

run()

Executes the coordinated shutdown sequence.

Runs all registered tasks across shutdown phases in reverse order. Tasks within each phase are executed in parallel for faster shutdown. Process exits with the specified code when complete.

public async run(
    exitCode?: number,
    exitProcess?: boolean
): Promise<void>

public async run(
    exitCode?: number,
    exitProcess?: boolean
): Promise<void>

Parameter: exitCode

Process exit code

Parameter: exitProcess

Whether to exit the process after shutdown

shutdown.addTask(ShutdownPhase.Services, 'database', () => db.disconnect(), 5000);
await shutdown.run(0); // Graceful shutdown

shutdown.addTask(ShutdownPhase.Services, 'database', () => db.disconnect(), 5000);
await shutdown.run(0); // Graceful shutdown

runPhase()

Run all tasks in a specific phase

protected async runPhase(phase: TPhase): Promise<void>

protected async runPhase(phase: TPhase): Promise<void>

Inherited from:CoordinatedLifecycle

runTaskWithTimeout()

Run a single task with timeout

protected async runTaskWithTimeout(
    phase: TPhase,
    task: LifecycleTask
): Promise<void>

protected async runTaskWithTimeout(
    phase: TPhase,
    task: LifecycleTask
): Promise<void>

Inherited from:CoordinatedLifecycle

waitFor()

Waits for an event to be emitted, resolving with the listener arguments tuple once triggered. Supports optional abort signals and timeouts for cancellation semantics.

async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

async waitFor<TEventKey>(
    event: TEventKey,
    opts?: { signal?: AbortSignal; timeoutMs?: number }
): Promise<TEvents[TEventKey]>

Parameter: event

The event name to wait for

Parameter: opts

Optional abort signal or timeout in milliseconds

Inherited from:StrictEventEmitter

constructor

Properties

Methods

logger

phaseEnum

phaseOrder

tasksMap

addListener()

addTask()

canAddTask()

canRemoveTask()

emit()

eventNamesTyped()

executeTasksInPhase()

getTaskType()

listenerCountTyped()

listeners()

off()

on()

once()

removeListener()

removeTask()

run()

runPhase()

runTaskWithTimeout()

waitFor()

constructor

Properties

Methods

logger

phaseEnum

phaseOrder

tasksMap

addListener()

addTask()

canAddTask()

canRemoveTask()

emit()

eventNamesTyped()

executeTasksInPhase()

getTaskType()

listenerCountTyped()

listeners()

off()

on()

once()

removeListener()

removeTask()

run()

runPhase()

runTaskWithTimeout()

waitFor()