Classservicesv0.6.0

CoordinatedLifecycle

Abstract base class for coordinated lifecycle management (startup/shutdown)

abstract class CoordinatedLifecycle<
    TPhase extends number,
    TEvents extends SEEventMapLike<TEvents>
> extends StrictEventEmitter<TEvents>

abstract class CoordinatedLifecycle<
    TPhase extends number,
    TEvents extends SEEventMapLike<TEvents>
> extends StrictEventEmitter<TEvents>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the CoordinatedLifecycleCoordinatedLifecycle class

protected CoordinatedLifecycle(
    loggerName: string,
    phaseOrder: TPhase[],
    phaseEnum: Record<number, string>
)

protected CoordinatedLifecycle(
    loggerName: string,
    phaseOrder: TPhase[],
    phaseEnum: Record<number, string>
)

Showing members with Protected visibility and higher.

TPhase

TPhase extends number

TPhase extends number

TEvents

TEvents extends SEEventMapLike<TEvents>

TEvents extends SEEventMapLike<TEvents>

logger

protected readonly logger: Logger

protected readonly logger: Logger

phaseEnum

protected readonly phaseEnum: Record<number, string>

protected readonly phaseEnum: Record<number, string>

phaseOrder

protected readonly phaseOrder: TPhase[]

protected readonly phaseOrder: TPhase[]

tasksMap

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

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

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 lifecycle task to a specific phase.

Tasks are executed in phase order during lifecycle operations. Each task has a timeout to prevent hanging operations.

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

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

Parameter: phase

The lifecycle phase to add the task to

Parameter: taskName

Unique name for the task (used for logging and removal)

Parameter: task

Async function to execute during the phase

Parameter: timeoutMs

Maximum time allowed for task execution in milliseconds

lifecycle.addTask(StartupPhase.Services, 'start-database', async () => {
  await database.connect();
}, 10000);

lifecycle.addTask(StartupPhase.Services, 'start-database', async () => {
  await database.connect();
}, 10000);

canAddTask()

protected abstract canAddTask(): boolean

protected abstract canAddTask(): boolean

canRemoveTask()

protected abstract canRemoveTask(): boolean

protected abstract 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 abstract async executeTasksInPhase(
    phase: TPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

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

getTaskType()

protected abstract getTaskType(): string

protected abstract 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 lifecycle task from a specific phase.

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

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

Parameter: phase

The lifecycle phase to remove the task from

Parameter: taskName

Name of the task to remove

runPhase()

Run all tasks in a specific phase

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

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

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>

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

CoordinatedLifecycle

Abstract base class for coordinated lifecycle management (startup/shutdown)

abstract class CoordinatedLifecycle<
    TPhase extends number,
    TEvents extends SEEventMapLike<TEvents>
> extends StrictEventEmitter<TEvents>

abstract class CoordinatedLifecycle<
    TPhase extends number,
    TEvents extends SEEventMapLike<TEvents>
> extends StrictEventEmitter<TEvents>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the CoordinatedLifecycleCoordinatedLifecycle class

protected CoordinatedLifecycle(
    loggerName: string,
    phaseOrder: TPhase[],
    phaseEnum: Record<number, string>
)

protected CoordinatedLifecycle(
    loggerName: string,
    phaseOrder: TPhase[],
    phaseEnum: Record<number, string>
)

Showing members with Protected visibility and higher.

TPhase

TPhase extends number

TPhase extends number

TEvents

TEvents extends SEEventMapLike<TEvents>

TEvents extends SEEventMapLike<TEvents>

logger

protected readonly logger: Logger

protected readonly logger: Logger

phaseEnum

protected readonly phaseEnum: Record<number, string>

protected readonly phaseEnum: Record<number, string>

phaseOrder

protected readonly phaseOrder: TPhase[]

protected readonly phaseOrder: TPhase[]

tasksMap

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

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

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 lifecycle task to a specific phase.

Tasks are executed in phase order during lifecycle operations. Each task has a timeout to prevent hanging operations.

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

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

Parameter: phase

The lifecycle phase to add the task to

Parameter: taskName

Unique name for the task (used for logging and removal)

Parameter: task

Async function to execute during the phase

Parameter: timeoutMs

Maximum time allowed for task execution in milliseconds

lifecycle.addTask(StartupPhase.Services, 'start-database', async () => {
  await database.connect();
}, 10000);

lifecycle.addTask(StartupPhase.Services, 'start-database', async () => {
  await database.connect();
}, 10000);

canAddTask()

protected abstract canAddTask(): boolean

protected abstract canAddTask(): boolean

canRemoveTask()

protected abstract canRemoveTask(): boolean

protected abstract 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 abstract async executeTasksInPhase(
    phase: TPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

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

getTaskType()

protected abstract getTaskType(): string

protected abstract 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 lifecycle task from a specific phase.

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

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

Parameter: phase

The lifecycle phase to remove the task from

Parameter: taskName

Name of the task to remove

runPhase()

Run all tasks in a specific phase

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

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

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>

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

TPhase

TEvents

logger

phaseEnum

phaseOrder

tasksMap

addListener()

addTask()

canAddTask()

canRemoveTask()

emit()

eventNamesTyped()

executeTasksInPhase()

getTaskType()

listenerCountTyped()

listeners()

off()

on()

once()

removeListener()

removeTask()

runPhase()

runTaskWithTimeout()

waitFor()

constructor

Properties

Methods

TPhase

TEvents

logger

phaseEnum

phaseOrder

tasksMap

addListener()

addTask()

canAddTask()

canRemoveTask()

emit()

eventNamesTyped()

executeTasksInPhase()

getTaskType()

listenerCountTyped()

listeners()

off()

on()

once()

removeListener()

removeTask()

runPhase()

runTaskWithTimeout()

waitFor()