Classhttpv0.7.0

Seedcord

The HTTP-interactions bot host, a long-running node server around the engine.

Discovers handlers from config.bot.interactions.path, verifies and dispatches interactions on start(), and runs coordinated shutdown with an in-flight drain. The edge deploy path calls createSeedcord from a generated entry.

class Seedcord<Cfg extends HttpConfig = HttpConfig>
    extends Pluggable<"http", RuntimeOfConfig<Cfg>>
    implements Core, SeedcordInstance

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Seedcord class

Seedcord(config: Cfg)

Showing members with Protected visibility and higher.

Methods

attach()
reset()
start()

Cfg

Cfg extends HttpConfig = HttpConfig

accessor

applicationId

The bot's Discord application id. Throws if you read it before the Configuration phase.

public get applicationId(): string

bus

public readonly bus: Bus

config

public readonly config: Cfg

isInitialized

protected isInitialized: boolean

Inherited from:Pluggable

plugins

protected readonly plugins: PluginLike[]

Inherited from:Pluggable

accessor

port

The bound server port, populated once start() is listening.

public get port(): number | undefined

rateLimiter

public readonly rateLimiter: IRateLimiter

rest

Workerd-compatible Discord REST client. start() sets the token.

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 by the ready fetch.

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 host and runs the startup tasks.

public async start(): Promise<this>

Classhttpv0.7.0

Seedcord

The HTTP-interactions bot host, a long-running node server around the engine.

class Seedcord<Cfg extends HttpConfig = HttpConfig>
    extends Pluggable<"http", RuntimeOfConfig<Cfg>>
    implements Core, SeedcordInstance

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the Seedcord class

Seedcord(config: Cfg)

Showing members with Protected visibility and higher.

Properties

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

Methods

attach()
reset()
start()

Cfg

Cfg extends HttpConfig = HttpConfig

accessor

applicationId

The bot's Discord application id. Throws if you read it before the Configuration phase.

public get applicationId(): string

bus

public readonly bus: Bus

config

public readonly config: Cfg

isInitialized

protected isInitialized: boolean

Inherited from:Pluggable

plugins

protected readonly plugins: PluginLike[]

Inherited from:Pluggable

accessor

port

The bound server port, populated once start() is listening.

public get port(): number | undefined

rateLimiter

public readonly rateLimiter: IRateLimiter

rest

Workerd-compatible Discord REST client. start() sets the token.

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 by the ready fetch.

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 host and runs the startup tasks.

public async start(): Promise<this>