Classseedcordv0.11.0

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

init()
onHmr()
registerCriticalFiles()

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

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>

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