Skip to main content
Version: Next

ScaffolderClient.(constructor)

Home > @backstage/plugin-scaffolder-common > ScaffolderClient > (constructor)

Constructs a new instance of the ScaffolderClient class

Signature:

constructor(options: {
discoveryApi: {
getBaseUrl(pluginId: string): Promise<string>;
};
fetchApi: {
fetch: typeof fetch;
};
identityApi?: {
getBackstageIdentity(): Promise<{
type: 'user';
userEntityRef: string;
ownershipEntityRefs: string[];
}>;
};
scmIntegrationsApi: ScmIntegrationRegistry;
useLongPollingLogs?: boolean;
});

Parameters

Parameter

Type

Description

options

{ discoveryApi: { getBaseUrl(pluginId: string): Promise<string>; }; fetchApi: { fetch: typeof fetch; }; identityApi?: { getBackstageIdentity(): Promise<{ type: 'user'; userEntityRef: string; ownershipEntityRefs: string[]; }>; }; scmIntegrationsApi: ScmIntegrationRegistry; useLongPollingLogs?: boolean; }