Classservicesv0.6.0

CoordinatedStartup

Manages bot startup lifecycle with ordered phases

Coordinates initialization of all bot components in a predictable sequence. Tasks are executed within their designated phases to ensure proper dependency order.

class CoordinatedStartup extends CoordinatedLifecycle<
    StartupPhase,
    CoordinatedStartupEvents
>

class CoordinatedStartup extends CoordinatedLifecycle<
    StartupPhase,
    CoordinatedStartupEvents
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the CoordinatedStartupCoordinatedStartup class

CoordinatedStartup()

CoordinatedStartup()

Showing members with Protected visibility and higher.

accessor

isReady

Check if startup has completed

public get isReady(): boolean

public get isReady(): boolean

accessor

isRunning

Check if startup is currently running

public get isRunning(): boolean

public get isRunning(): boolean

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

abort()

Aborts the startup sequence if it is currently running.

public abort(): void

public abort(): void

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 startup phase with timeout.

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

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

Parameter: phase

The startup phase from StartupPhaseStartupPhase

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: StartupPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

protected async executeTasksInPhase(
    phase: StartupPhase,
    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 lifecycle task from a specific phase.

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

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

Parameter: phase

The lifecycle phase to remove the task from

Parameter: taskName

Name of the task to remove

Inherited from:CoordinatedLifecycle

run()

Executes the coordinated startup sequence.

Runs all registered tasks across startup phases in the correct order. Each phase completes before the next phase begins. Tasks within a phase are executed sequentially to maintain predictable initialization.

public async run(): Promise<void>

public async run(): Promise<void>

Throws:

An ErrorError If startup fails or is called multiple times

const startup = new CoordinatedStartup();
startup.addTask(StartupPhase.Services, 'database', () => db.connect(), 10000);
await startup.run();

const startup = new CoordinatedStartup();
startup.addTask(StartupPhase.Services, 'database', () => db.connect(), 10000);
await startup.run();

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()

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

protected async runTaskWithTimeout(
    phase: StartupPhase,
    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

CoordinatedStartup

Manages bot startup lifecycle with ordered phases

Coordinates initialization of all bot components in a predictable sequence. Tasks are executed within their designated phases to ensure proper dependency order.

class CoordinatedStartup extends CoordinatedLifecycle<
    StartupPhase,
    CoordinatedStartupEvents
>

class CoordinatedStartup extends CoordinatedLifecycle<
    StartupPhase,
    CoordinatedStartupEvents
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the CoordinatedStartupCoordinatedStartup class

CoordinatedStartup()

CoordinatedStartup()

Showing members with Protected visibility and higher.

accessor

isReady

Check if startup has completed

public get isReady(): boolean

public get isReady(): boolean

accessor

isRunning

Check if startup is currently running

public get isRunning(): boolean

public get isRunning(): boolean

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

abort()

Aborts the startup sequence if it is currently running.

public abort(): void

public abort(): void

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 startup phase with timeout.

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

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

Parameter: phase

The startup phase from StartupPhaseStartupPhase

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: StartupPhase,
    tasks: LifecycleTask[]
): Promise<PromiseSettledResult<void>[]>

protected async executeTasksInPhase(
    phase: StartupPhase,
    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 lifecycle task from a specific phase.

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

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

Parameter: phase

The lifecycle phase to remove the task from

Parameter: taskName

Name of the task to remove

Inherited from:CoordinatedLifecycle

run()

Executes the coordinated startup sequence.

public async run(): Promise<void>

public async run(): Promise<void>

Throws:

An ErrorError If startup fails or is called multiple times

const startup = new CoordinatedStartup();
startup.addTask(StartupPhase.Services, 'database', () => db.connect(), 10000);
await startup.run();

const startup = new CoordinatedStartup();
startup.addTask(StartupPhase.Services, 'database', () => db.connect(), 10000);
await startup.run();

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()

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

protected async runTaskWithTimeout(
    phase: StartupPhase,
    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

isReady

isRunning

logger

phaseEnum

phaseOrder

tasksMap

abort()

addListener()

addTask()

canAddTask()

canRemoveTask()

emit()

eventNamesTyped()

executeTasksInPhase()

getTaskType()

listenerCountTyped()

listeners()

off()

on()

once()

removeListener()

removeTask()

run()

runPhase()

runTaskWithTimeout()

waitFor()

constructor

Properties

Methods

isReady

isRunning

logger

phaseEnum

phaseOrder

tasksMap

abort()

addListener()

addTask()

canAddTask()

canRemoveTask()

emit()

eventNamesTyped()

executeTasksInPhase()

getTaskType()

listenerCountTyped()

listeners()

off()

on()

once()

removeListener()

removeTask()

run()

runPhase()

runTaskWithTimeout()

waitFor()