Class DefaultPluginContext

container

• get container(): Container

  Expose container as the minimal Container interface. PluginContext consumers only see the minimal interface.

  Returns Container

constructor

• new DefaultPluginContext(
      awilixContainer: AwilixContainer,
      logger: Logger,
      config: Map<string, unknown>,
  ): DefaultPluginContext

  Parameters

  • awilixContainer: AwilixContainer
  • logger: Logger
  • config: Map<string, unknown>

  Returns DefaultPluginContext

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);
  Copy

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');
  }
  Copy

Readonlylogger