Classseedcordv0.10.6

Plugin

Base class for Seedcord plugins

Extend this class to create plugins that integrate with the Seedcord lifecycle. Plugins have access to the core instance and must implement initialization logic.

abstract class Plugin<
    TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents
>
    extends StrictEventEmitter<TPluginEvents>
    implements Initializeable, HmrAware

abstract class Plugin<
    TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents
>
    extends StrictEventEmitter<TPluginEvents>
    implements Initializeable, HmrAware

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the PluginPlugin class

Plugin(pluggable: Core)

Plugin(pluggable: Core)

Showing members with Protected visibility and higher.

Methods

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

TPluginEvents

TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents

TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents

logger

Logger instance for this plugin - must be implemented by subclasses

public abstract logger: Logger

public abstract logger: Logger

name

public name: string

public name: string

pluggable

protected pluggable: Core

protected pluggable: Core

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

virtual

init()

Initialize the plugin - implement setup logic here Override this method in your plugin classes

public abstract async init(): Promise<void>

public abstract async init(): Promise<void>

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

virtual

onHmr()

Reloads plugin state on an HMR update.

public async onHmr(_event: HmrUpdateEvent): Promise<void>

public async onHmr(_event: HmrUpdateEvent): Promise<void>

Parameter: _event

The HMR update event Override this method to handle HMR updates

registerCriticalFiles()

Registers critical file patterns that should trigger a full restart when changed in Dev HMR.

protected registerCriticalFiles(
    patterns: string[]
): void

protected registerCriticalFiles(
    patterns: string[]
): void

Parameter: patterns

Glob patterns relative to the project root

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

Classseedcordv0.10.6

Plugin

Base class for Seedcord plugins

Extend this class to create plugins that integrate with the Seedcord lifecycle. Plugins have access to the core instance and must implement initialization logic.

abstract class Plugin<
    TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents
>
    extends StrictEventEmitter<TPluginEvents>
    implements Initializeable, HmrAware

abstract class Plugin<
    TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents
>
    extends StrictEventEmitter<TPluginEvents>
    implements Initializeable, HmrAware

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the PluginPlugin class

Plugin(pluggable: Core)

Plugin(pluggable: Core)

Showing members with Protected visibility and higher.

Properties

logger
name
pluggable

Methods

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

TPluginEvents

TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents

TPluginEvents extends SEEventMapLike<TPluginEvents> = SENoEvents

logger

Logger instance for this plugin - must be implemented by subclasses

public abstract logger: Logger

public abstract logger: Logger

name

public name: string

public name: string

pluggable

protected pluggable: Core

protected pluggable: Core

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

virtual

init()

Initialize the plugin - implement setup logic here Override this method in your plugin classes

public abstract async init(): Promise<void>

public abstract async init(): Promise<void>

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

virtual

onHmr()

Reloads plugin state on an HMR update.

public async onHmr(_event: HmrUpdateEvent): Promise<void>

public async onHmr(_event: HmrUpdateEvent): Promise<void>

Parameter: _event

The HMR update event Override this method to handle HMR updates

registerCriticalFiles()

Registers critical file patterns that should trigger a full restart when changed in Dev HMR.

protected registerCriticalFiles(
    patterns: string[]
): void

protected registerCriticalFiles(
    patterns: string[]
): void

Parameter: patterns

Glob patterns relative to the project root

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