Interface BackendPluginRegistrationPoints

The callbacks passed to the register method of a backend plugin.

interface BackendPluginRegistrationPoints {
    registerExtensionPoint<TExtensionPoint>(
        ref: ExtensionPoint<TExtensionPoint>,
        impl: TExtensionPoint,
    ): void;
    registerExtensionPoint<TExtensionPoint>(
        options: {
            extensionPoint: ExtensionPoint<TExtensionPoint>;
            factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
        },
    ): void;
    registerInit<TDeps extends { [key: string]: ServiceRef<unknown> }>(
        options: {
            deps: TDeps;
            init(deps: DepsToInstances<TDeps>): Promise<void>;
        },
    ): void;
}

Index

Methods

registerExtensionPoint registerInit

Methods

registerExtensionPoint

registerExtensionPoint<TExtensionPoint>(
ref: ExtensionPoint<TExtensionPoint>,
impl: TExtensionPoint,
): void
Registers an implementation for an extension point.
Type Parameters
- TExtensionPoint
Parameters
- ref: ExtensionPoint<TExtensionPoint>
- impl: TExtensionPoint
Returns void
- Defined in packages/backend-plugin-api/src/wiring/types.ts:73
registerExtensionPoint<TExtensionPoint>(
    options: {
        extensionPoint: ExtensionPoint<TExtensionPoint>;
        factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
    },
): void
Registers a factory that produces a separate implementation for an extension point for each module.
Type Parameters
- TExtensionPoint
Parameters
- options: {
  extensionPoint: ExtensionPoint<TExtensionPoint>;
  factory: (context: ExtensionPointFactoryContext) => TExtensionPoint;
  }
Returns void
- Defined in packages/backend-plugin-api/src/wiring/types.ts:80

registerInit

registerInit<TDeps extends { [key: string]: ServiceRef<unknown> }>(
    options: {
        deps: TDeps;
        init(deps: DepsToInstances<TDeps>): Promise<void>;
    },
): void
Type Parameters
- TDeps extends { [key: string]: ServiceRef<unknown> }
Parameters
- options: { deps: TDeps; init(deps: DepsToInstances<TDeps>): Promise<void> }
Returns void
- Defined in packages/backend-plugin-api/src/wiring/types.ts:84