ApiFactoryRegistry.register()

Home > @backstage/core-app-api > ApiFactoryRegistry > register

Register a new API factory. Returns true if the factory was added to the registry.

A factory will not be added to the registry if there is already an existing factory with the same or higher priority.

Signature:

register<Api, Impl extends Api, Deps extends {
        [name in string]: unknown;
    }>(scope: ApiFactoryScope, factory: ApiFactory<Api, Impl, Deps>): boolean;

Parameters

Parameter	Type	Description
scope	ApiFactoryScope
factory	ApiFactory<Api, Impl, Deps>

Returns:

boolean