interface IPluginContext
Since 0.1.0

The registration context handed to IPlugin.register — every extension point a plugin can touch.

Properties

Service registration and resolution.

Middleware pipeline.

Route registration.

Environment variable validation.

Health check registration.

Metric registration.

OpenAPI contributions.

Custom decorator registration.

readonly
cli: ICliApi

CLI command registration.

Lifecycle hooks.

Runtime services. Non-optional by contract: a runtime provider is mandatory and the kernel registers it first, so every other plugin can rely on it during registration (see ARCHITECTURE.md §7).

readonly
optional
config: IConfig

Configuration access (from the ConfigPlugin, when registered).

readonly
optional
logger: ILogger

Logger (from the LoggerPlugin, when registered).

readonly
optional
metadata: IMetadataStore

Decorator metadata store (from the DecoratorPlugin, when registered).

readonly
optional
container: IContainer

DI container (from the DiPlugin, when registered).

readonly
options: Readonly<Record<string, unknown>>

Options the application passed to this plugin's factory.

readonly
app: IApplication

The owning application.

Usage

import { type IPluginContext } from "common/src/index.ts";