Class ScaffolderClient

constructor

• new ScaffolderClient(
      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;
      },
  ): ScaffolderClient

  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