Interface PluginContext

Context provided to plugins during initialization.

Allows plugins to register services and access the application container.

Example

class DatabasePlugin implements Plugin {
  async initialize(context: PluginContext): Promise<void> {
    const config = context.getConfig<DatabaseConfig>();
    const database = new Database(config);

    context.container.register('database', () => database, {
      lifetime: ServiceLifetime.SINGLETON
    });
  }
}
interface PluginContext {
    container: Container;
    logger: Logger;
    getConfig<T = Record<string, unknown>>(): T;
    getService<T>(name: string): undefined | T;
}

Methods

getConfig getService

Properties

container logger

Methods

getConfig

  • getConfig<T = Record<string, unknown>>(): T

    Gets configuration for this plugin.

    Type Parameters

    • T = Record<string, unknown>

      The configuration type

    Returns T

    The plugin configuration

    Example

    const config = context.getConfig<DatabaseConfig>();
    console.log(config.host, config.port);

getService

  • getService<T>(name: string): undefined | T

    Gets a service from the container if it exists.

    Type Parameters

    • T

      The service type

    Parameters

    • name: string

      The service name

    Returns undefined | T

    The service instance if it exists, undefined otherwise

    Example

    const metrics = context.getService<Metrics>('metrics');
    if (metrics) {
      metrics.increment('database.connections');
    }

Properties

container

container: Container

The dependency injection container. Plugins can register services here.

logger

logger: Logger

Logger instance for the plugin.

Settings

Member Visibility

On This Page

Methods
Properties