makeLegacyPlugin()

Home > @backstage/backend-common > makeLegacyPlugin

Creates a new custom plugin compatibility wrapper.

Signature:

function makeLegacyPlugin<TEnv extends Record<string, unknown>, TEnvTransforms extends {
    [key in keyof TEnv]?: (dep: TEnv[key]) => unknown;
}>(envMapping: {
    [key in keyof TEnv]: ServiceRef<TEnv[key]>;
}, envTransforms: TEnvTransforms): (name: string, createRouterImport: Promise<{
    default: LegacyCreateRouter<TransformedEnv<TEnv, TEnvTransforms>>;
}>) => import("@backstage/backend-plugin-api").BackendFeature;

Parameters

Parameter	Type	Description
envMapping	{ [key in keyof TEnv]: ServiceRef<TEnv[key]>; }
envTransforms	TEnvTransforms

Returns:

(name: string, createRouterImport: Promise<{ default: LegacyCreateRouter<TransformedEnv<TEnv, TEnvTransforms>>; }>) => import("@backstage/backend-plugin-api").BackendFeature

Remarks

Usually you can use legacyPlugin directly instead, but you might need to use this if you have customized the plugin environment in your backend.