Classcore/nodev0.7.0

Pluggable

Base class for a plugin host, a transport Seedcord class.

You attach plugins while configuring the bot. Within one startup phase, their init() calls run one after another in attach order.

abstract class Pluggable<
    BotT extends Transport,
    BotRt extends Runtime
> implements CoreBase

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Pluggable class

Pluggable(shutdown: CoordinatedShutdown, startup: CoordinatedStartup)

Showing members with Protected visibility and higher.

Methods

attach()

BotT

BotT extends Transport

BotRt

BotRt extends Runtime

applicationId

public readonly abstract applicationId: string

bus

public readonly abstract bus: Bus

config

public readonly abstract config: Config

isInitialized

protected isInitialized: boolean

plugins

protected readonly plugins: PluginLike[]

rateLimiter

public readonly abstract rateLimiter: IRateLimiter

rest

public readonly abstract rest: REST

shutdown

Add a task that runs while the bot shuts down.

public readonly shutdown: Pick<CoordinatedShutdown, 'addTask'>

startFailed

protected startFailed: boolean

startup

Add a task that runs while the bot starts.

public readonly startup: Pick<CoordinatedStartup, 'addTask'>

attach()

Attaches a plugin under key. Read the instance back as core[key]. seedcord codegen writes the Core augmentation that types it there.

Startup runs each plugin's init() in attach order within its phase.

Attaching a plugin whose transport or runtime differs from this host fails to compile. Your constructor takes CoreBase as its first parameter (you don't need to pass it though). A narrower one fails to compile here.

public attach<Key, Ctor>(
    this: this,
    key: ChannelKeyAssert<Key>,
    Plugin: Ctor &
        TransportAssert<InstanceType<Ctor>, BotT> &
        RuntimeAssert<InstanceType<Ctor>, BotRt> &
        CoreParamAssert<Ctor>,
    args: PluginArgs<Ctor>
): this & Record<Key, InstanceType<Ctor>>

Parameter: key

Also the channel the plugin logs on. Reserved channel names throw.

Parameter: args

Whatever your constructor takes after the host.

Throws:

A SeedcordError if you attach after the bot has started. A taken or reserved key throws too.