Classcore/pluginv0.2.1-next.0

Plugin

Base class for Seedcord plugins. A subclass declares its options as the Opts type argument, implements init(), and reads the framework surface through this.core.

abstract class Plugin<
    Opts extends PluginOptions = {},
    TCore extends CoreBase = CoreBase
>
    implements Initializeable, HmrAware

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Plugin class

Plugin(host: CoreBase, spec?: PluginLifecycleSpec)

Showing members with Protected visibility and higher.

Methods

dispose()
init()
onHmr()
ready()
registerCriticalFiles()
rejectOptions()

Opts

The plugin's declared PluginOptions.

Opts extends PluginOptions = {}

TCore

The host type this.core resolves to. Each transport binds it to its own Core.

TCore extends CoreBase = CoreBase

core

The host, typed to the transport whose Plugin base this class extends.

protected core: TCore

logger

Logs under the plugin's class name, on the channel its attach key sets.

protected readonly logger: Logger

optional

dispose()

Runs during teardown, only when init() resolved.

public async dispose(): Promise<void>

init()

public abstract async init(): Promise<void>

onHmr()

Override to reload plugin state on an HMR update.

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

optional

ready()

Runs in the startup Ready phase, after init(). The gateway client is logged in by this phase, and the http host binds its server in the same phase.

public async ready(): Promise<void>

registerCriticalFiles()

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

protected registerCriticalFiles(
    patterns: string[]
): void

Parameter: patterns

Glob patterns relative to the project root

rejectOptions()

Throws a SeedcordError that contains the plugin class name and the reason.

protected rejectOptions(reason: string): never

Parameter: reason

Why the options are invalid.