Classseedcordv0.10.6Internal

Pluggable

Base class for objects that can have plugins attached

Provides plugin attachment capabilities and lifecycle management. Plugins are attached during configuration and initialized during startup.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PluggablePluggable class.

class Pluggable<
    TPluggableEvents extends SEEventMapLike<TPluggableEvents> =
        SENoEvents
> extends StrictEventEmitter<TPluggableEvents>

class Pluggable<
    TPluggableEvents extends SEEventMapLike<TPluggableEvents> =
        SENoEvents
> extends StrictEventEmitter<TPluggableEvents>

Member visibility

Filter class members by access level.

internal

constructor

Constructs a new instance of the PluggablePluggable class

Pluggable(shutdown: CoordinatedShutdown, startup: CoordinatedStartup)

Pluggable(shutdown: CoordinatedShutdown, startup: CoordinatedStartup)

Showing members with Protected visibility and higher.

Methods

addListener()
emit()
eventNamesTyped()
listenerCountTyped()
listeners()
off()
on()
once()
removeListener()
waitFor()

TPluggableEvents

TPluggableEvents extends SEEventMapLike<TPluggableEvents> = SENoEvents

TPluggableEvents extends SEEventMapLike<TPluggableEvents> = SENoEvents

internal

isInitialized

protected isInitialized: boolean

protected isInitialized: boolean

internal

plugins

protected readonly plugins: Plugin[]

protected readonly plugins: Plugin[]

internal

shutdown

protected readonly shutdown: CoordinatedShutdown

protected readonly shutdown: CoordinatedShutdown

internal

startup

protected readonly startup: CoordinatedStartup

protected readonly startup: CoordinatedStartup

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

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

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

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

Pluggable

Base class for objects that can have plugins attached

Provides plugin attachment capabilities and lifecycle management. Plugins are attached during configuration and initialized during startup.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PluggablePluggable class.