Backstage
    Preparing search index...

    An API to interact with the scaffolder backend.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    • Parameters

      • options: {
            discoveryApi: { getBaseUrl(pluginId: string): Promise<string> };
            fetchApi: {
                fetch: {
                    (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
                    (input: string | Request | URL, init?: RequestInit): Promise<Response>;
                };
            };
            identityApi?: {
                getBackstageIdentity(): Promise<
                    { ownershipEntityRefs: string[]; type: "user"; userEntityRef: string },
                >;
            };
            scmIntegrationsApi: ScmIntegrationRegistry;
            useLongPollingLogs?: boolean;
        }

      Returns ScaffolderClient

    Methods

    • Parameters

      • __namedParameters: {
            context: Record<string, string>;
            provider: string;
            resource: string;
            token: string;
        }

      Returns Promise<{ results: { id: string; title?: string }[] }>