Classgatewayv0.6.0

Seedcord

The gateway bot host. Opens a discord.js gateway session, discovers handlers, and runs coordinated startup and shutdown. Attach plugins with attach().

class Seedcord
    extends Pluggable<"gateway", "server">
    implements Core, SeedcordInstance

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Seedcord class

Seedcord(config: GatewayConfig)

Parameter: config

Bot configuration including paths and Discord client options

Throws:

A SeedcordError When attempting to create multiple instances (singleton)

Showing members with Protected visibility and higher.

Methods

attach()
reset()
start()

accessor

applicationId

The bot's Discord application id. Throws if you read it before login.

public get applicationId(): string

bot

public readonly bot: Bot

bus

public readonly bus: Bus

config

public readonly config: GatewayConfig

isInitialized

protected isInitialized: boolean

Inherited from:Pluggable

plugins

protected readonly plugins: PluginLike[]

Inherited from:Pluggable

rateLimiter

public readonly rateLimiter: IRateLimiter

rest

The discord.js client's REST client. Its token is set during the Login phase.

public readonly rest: REST

shutdown

Add a task that runs while the bot shuts down.

readonly shutdown: Pick<CoordinatedShutdown, 'addTask'>

Inherited from:Pluggable

startFailed

protected startFailed: boolean

Inherited from:Pluggable

startup

Add a task that runs while the bot starts.

readonly startup: Pick<CoordinatedStartup, 'addTask'>

Inherited from:Pluggable

accessor

username

The bot's discord username, populated after login.

public get username(): string | undefined

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.

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.

Inherited from:Pluggable

reset()

protected static reset(host?: object): boolean

start()

Starts the bot and runs all initialization tasks

public async start(): Promise<this>

Classgatewayv0.6.0

Seedcord

The gateway bot host. Opens a discord.js gateway session, discovers handlers, and runs coordinated startup and shutdown. Attach plugins with attach().

class Seedcord
    extends Pluggable<"gateway", "server">
    implements Core, SeedcordInstance

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Seedcord class

Seedcord(config: GatewayConfig)

Parameter: config

Bot configuration including paths and Discord client options

Throws:

A SeedcordError When attempting to create multiple instances (singleton)

Showing members with Protected visibility and higher.

Properties

applicationId
bot
bus
config
isInitialized
plugins
rateLimiter
rest
shutdown
startFailed
startup
username

Methods

attach()
reset()
start()

accessor

applicationId

The bot's Discord application id. Throws if you read it before login.

public get applicationId(): string

bot

public readonly bot: Bot

bus

public readonly bus: Bus

config

public readonly config: GatewayConfig

isInitialized

protected isInitialized: boolean

Inherited from:Pluggable

plugins

protected readonly plugins: PluginLike[]

Inherited from:Pluggable

rateLimiter

public readonly rateLimiter: IRateLimiter

rest

The discord.js client's REST client. Its token is set during the Login phase.

public readonly rest: REST

shutdown

Add a task that runs while the bot shuts down.

readonly shutdown: Pick<CoordinatedShutdown, 'addTask'>

Inherited from:Pluggable

startFailed

protected startFailed: boolean

Inherited from:Pluggable

startup

Add a task that runs while the bot starts.

readonly startup: Pick<CoordinatedStartup, 'addTask'>

Inherited from:Pluggable

accessor

username

The bot's discord username, populated after login.

public get username(): string | undefined

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.

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.

Inherited from:Pluggable

reset()

protected static reset(host?: object): boolean

start()

Starts the bot and runs all initialization tasks

public async start(): Promise<this>