createFetchCatalogEntityAction()

Home > @backstage/plugin-scaffolder-backend > createFetchCatalogEntityAction

Returns entity or entities from the catalog by entity reference(s).

Signature:

function createFetchCatalogEntityAction(options: {
    catalogClient: CatalogApi;
    auth?: AuthService;
}): import("@backstage/plugin-scaffolder-node").TemplateAction<{
    entityRef?: string | undefined;
    entityRefs?: string[] | undefined;
    optional?: boolean | undefined;
    defaultKind?: string | undefined;
    defaultNamespace?: string | undefined;
}, {
    entity?: any;
    entities?: any[] | undefined;
}>;

Parameters

Parameter	Type	Description
options	{ catalogClient: CatalogApi; auth?: AuthService; }

Returns:

import("@backstage/plugin-scaffolder-node").TemplateAction<{ entityRef?: string | undefined; entityRefs?: string[] | undefined; optional?: boolean | undefined; defaultKind?: string | undefined; defaultNamespace?: string | undefined; }, { entity?: any; entities?: any[] | undefined; }>

Parameters​

Parameters