Setu-TS
    Preparing search index...

    Interface IPluginContext

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

    0.1.0

    interface IPluginContext {
        app: IApplication;
        cli: ICliApi;
        config?: IConfig;
        container?: IContainer;
        decorators: IDecoratorApi;
        environment: IEnvironmentApi;
        health: IHealthApi;
        lifecycle: ILifecycleApi;
        logger?: ILogger;
        metadata?: IMetadataStore;
        metrics: IMetricsApi;
        middleware: IMiddlewareApi;
        openapi: IOpenApiApi;
        options: Readonly<Record<string, unknown>>;
        router: IRouterApi;
        runtime: IRuntimeServices;
        services: IServiceRegistry;
    }
    Index
    app cli config? container? decorators environment health lifecycle logger? metadata? metrics middleware openapi options router runtime services
    app: IApplication

    The owning application.

    cli: ICliApi

    CLI command registration.

    config?: IConfig

    Configuration access (from the ConfigPlugin, when registered).

    container?: IContainer

    DI container (from the DiPlugin, when registered).

    decorators: IDecoratorApi

    Custom decorator registration.

    environment: IEnvironmentApi

    Environment variable validation.

    health: IHealthApi

    Health check registration.

    lifecycle: ILifecycleApi

    Lifecycle hooks.

    logger?: ILogger

    Logger (from the LoggerPlugin, when registered).

    metadata?: IMetadataStore

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

    metrics: IMetricsApi

    Metric registration.

    middleware: IMiddlewareApi

    Middleware pipeline.

    openapi: IOpenApiApi

    OpenAPI contributions.

    options: Readonly<Record<string, unknown>>

    Options the application passed to this plugin's factory.

    router: IRouterApi

    Route registration.

    runtime: IRuntimeServices

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

    services: IServiceRegistry

    Service registration and resolution.

    Settings
    Member Visibility

    On This Page
    Properties