Classgatewayv0.1.0-next.3

Seedcord

Main Seedcord bot framework class

Primary entry point for creating Discord bots with Seedcord. Manages component lifecycle and provides plugin support.

class Seedcord extends Pluggable implements Core

class Seedcord extends Pluggable implements Core

Member visibility

Filter class members by access level.

constructor

Creates a new Seedcord instance

Seedcord(config: GatewayConfig)

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()
start()

bot

public readonly bot: Bot

public readonly bot: Bot

bus

public readonly bus: Bus

public readonly bus: Bus

config

public readonly config: GatewayConfig

public readonly config: GatewayConfig

isInitialized

protected isInitialized: boolean

protected isInitialized: boolean

Inherited from:Pluggable

plugins

protected readonly plugins: Plugin[]

protected readonly plugins: Plugin[]

Inherited from:Pluggable

rateLimiter

public readonly rateLimiter: IRateLimiter

public readonly rateLimiter: IRateLimiter

shutdown

public readonly shutdown: CoordinatedShutdown

public readonly shutdown: CoordinatedShutdown

startup

public readonly startup: CoordinatedStartup

public readonly startup: CoordinatedStartup

username

The bot's discord username, populated after login.

public get username(): string | undefined

public get username(): string | undefined

attach()

Attaches a plugin to this instance

Plugins provide external functionality and are initialized during the specified startup phase. The plugin instance becomes available as a property in corecore wherever it's available.

Make sure to augment the CoreCore interface with the plugin type to ensure TypeScript recognizes it and provides intellisense.

attach<Key, Ctor>(
    this: this,
    key: Key,
    Plugin: Ctor,
    startupPhase: StartupPhase,
    args: PluginArgs<Ctor>
): this & Record<Key, InstanceType<Ctor>>

attach<Key, Ctor>(
    this: this,
    key: Key,
    Plugin: Ctor,
    startupPhase: StartupPhase,
    args: PluginArgs<Ctor>
): this & Record<Key, InstanceType<Ctor>>

Parameter: key

Property name to access the plugin instance

Parameter: Plugin

Plugin constructor class

Parameter: startupPhase

When during startup to initialize this plugin (StartupPhase)

Parameter: args

Additional arguments to pass to the plugin constructor

Type parameter: Key

The property name for accessing the plugin

Type parameter: Ctor

The plugin constructor type

Throws:

A SeedcordError When called after initialization or if key already exists

seedcord.attach('db', Mongo, StartupPhase.Configuration, { uri: 'mongodb://...', name: 'seedcord', dir: ... })

seedcord.attach('db', Mongo, StartupPhase.Configuration, { uri: 'mongodb://...', name: 'seedcord', dir: ... })

Inherited from:Pluggable

start()

Starts the bot and runs all initialization tasks

public async start(): Promise<this>

public async start(): Promise<this>

Classgatewayv0.1.0-next.3

Seedcord

Main Seedcord bot framework class

Primary entry point for creating Discord bots with Seedcord. Manages component lifecycle and provides plugin support.

class Seedcord extends Pluggable implements Core

class Seedcord extends Pluggable implements Core

Member visibility

Filter class members by access level.

constructor

Creates a new Seedcord instance

Seedcord(config: GatewayConfig)

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

bot
bus
config
isInitialized
plugins
rateLimiter
shutdown
startup
username

Methods

attach()
start()

bot

public readonly bot: Bot

public readonly bot: Bot

bus

public readonly bus: Bus

public readonly bus: Bus

config

public readonly config: GatewayConfig

public readonly config: GatewayConfig

isInitialized

protected isInitialized: boolean

protected isInitialized: boolean

Inherited from:Pluggable

plugins

protected readonly plugins: Plugin[]

protected readonly plugins: Plugin[]

Inherited from:Pluggable

rateLimiter

public readonly rateLimiter: IRateLimiter

public readonly rateLimiter: IRateLimiter

shutdown

public readonly shutdown: CoordinatedShutdown

public readonly shutdown: CoordinatedShutdown

startup

public readonly startup: CoordinatedStartup

public readonly startup: CoordinatedStartup

username

The bot's discord username, populated after login.

public get username(): string | undefined

public get username(): string | undefined

attach()

Attaches a plugin to this instance

Plugins provide external functionality and are initialized during the specified startup phase. The plugin instance becomes available as a property in corecore wherever it's available.

Make sure to augment the CoreCore interface with the plugin type to ensure TypeScript recognizes it and provides intellisense.

attach<Key, Ctor>(
    this: this,
    key: Key,
    Plugin: Ctor,
    startupPhase: StartupPhase,
    args: PluginArgs<Ctor>
): this & Record<Key, InstanceType<Ctor>>

attach<Key, Ctor>(
    this: this,
    key: Key,
    Plugin: Ctor,
    startupPhase: StartupPhase,
    args: PluginArgs<Ctor>
): this & Record<Key, InstanceType<Ctor>>

Parameter: key

Property name to access the plugin instance

Parameter: Plugin

Plugin constructor class

Parameter: startupPhase

When during startup to initialize this plugin (StartupPhase)

Parameter: args

Additional arguments to pass to the plugin constructor

Type parameter: Key

The property name for accessing the plugin

Type parameter: Ctor

The plugin constructor type

Throws:

A SeedcordError When called after initialization or if key already exists

seedcord.attach('db', Mongo, StartupPhase.Configuration, { uri: 'mongodb://...', name: 'seedcord', dir: ... })

seedcord.attach('db', Mongo, StartupPhase.Configuration, { uri: 'mongodb://...', name: 'seedcord', dir: ... })

Inherited from:Pluggable

start()

Starts the bot and runs all initialization tasks

public async start(): Promise<this>

public async start(): Promise<this>