Skip to content
Classgatewayv0.9.0

Plugin

Base class for a gateway plugin, binding this.core to the gateway Core.

To run on either transport, extend the base from @seedcord/core/plugin. Its this.core carries only the shared members.

abstract class Plugin<
    Opts extends GatewayPluginOptions = { transport: "gateway"; runtime: "server" }
> extends Plugin<
    Opts,
    Core,
    keyof typeof GATEWAY_SCOPE
>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Plugin class

Plugin(
    host: CoreBase,
    [spec],
    input: PluginSpecArgs<Opts, Fixed>
)

Inherited from:Plugin

Showing members with Protected visibility and higher.

Properties

Methods

Opts

The transport and runtime the plugin declares.

Opts extends GatewayPluginOptions = { transport: 'gateway'; runtime: 'server'; }

core

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

protected core: TCore

Inherited from:Plugin

kv

This plugin's records in the bot's config.kv, stored under its attach key. Two attachments of one plugin class each get their own records. Renaming the attach key leaves the records under the old key behind.

protected kv: Kv

Inherited from:Plugin

Throws:

  • A SeedcordTypeError when something built the plugin with new outside attach().

logger

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

protected readonly logger: Logger

Inherited from:Plugin

codegen()

Returns data that seedcord codegen writes into the bot's seedcord-gen.ts as a type. Read it back with Generated<typeof YourPlugin>. Return plain data, or classes and objects that a project file or your plugin's package exports. The class needs a static readonly id.

seedcord codegen calls this without running init(). Read only what the constructor stored and the bot's files.

async codegen?(): Promise<unknown>

Inherited from:Plugin

dispose()

Runs during teardown, in ShutdownPhase.Disconnect by default. seedcord skips it when init() has thrown.

When init() outlasts its timeout, seedcord calls this once that init() resolves, outside any shutdown phase. The process must still be alive for that call to happen.

dispose?(): Promisable<void>

Inherited from:Plugin

ready()

Runs in the Ready phase, after every attached plugin's init() has resolved. The other Ready tasks run alongside it, including the http server binding its port.

Override it when your work needs a logged-in client or a resolved application id.

ready?(): Promisable<void>

Inherited from:Plugin

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. A relative one resolves against root from seedcord.config.ts.

Inherited from:Plugin

rejectOptions()

Rejects the options this plugin got.

protected rejectOptions(reason: string): never
Parameter: reason

Why the options are invalid.

Throws:

A SeedcordTypeError every time, with the plugin class name and reason in its message.

Inherited from:Plugin