Classseedcordv0.13.0

Pluggable

Base class for objects that can have plugins attached.

Provides plugin attachment capabilities and lifecycle management. Plugins are attached during configuration and initialized during startup. Not constructed directly, the host is a SeedcordSeedcord.

class Pluggable<
    TPluggableEvents extends SEEventMapLike<TPluggableEvents> =
        SENoEvents
> extends StrictEventEmitter<TPluggableEvents>

class Pluggable<
    TPluggableEvents extends SEEventMapLike<TPluggableEvents> =
        SENoEvents
> extends StrictEventEmitter<TPluggableEvents>

Member visibility

Filter class members by access level.

constructor

Constructs a new instance of the PluggablePluggable class

Pluggable(shutdown: CoordinatedShutdown, startup: CoordinatedStartup)

Pluggable(shutdown: CoordinatedShutdown, startup: CoordinatedStartup)

Showing members with Protected visibility and higher.

Methods

attach()

TPluggableEvents

TPluggableEvents extends SEEventMapLike<TPluggableEvents> = SENoEvents

TPluggableEvents extends SEEventMapLike<TPluggableEvents> = SENoEvents

isInitialized

protected isInitialized: boolean

protected isInitialized: boolean

plugins

protected readonly plugins: Plugin[]

protected readonly plugins: Plugin[]

shutdown

protected readonly shutdown: CoordinatedShutdown

protected readonly shutdown: CoordinatedShutdown

startup

protected readonly startup: CoordinatedStartup

protected readonly startup: CoordinatedStartup

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.

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

public 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 (StartupPhaseStartupPhase)

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: ... })