CatalogProcessor

Home > @backstage/plugin-catalog-node > CatalogProcessor

Signature:

export type CatalogProcessor = {
    getProcessorName(): string;
    readLocation?(location: LocationSpec, optional: boolean, emit: CatalogProcessorEmit, parser: CatalogProcessorParser, cache: CatalogProcessorCache): Promise<boolean>;
    preProcessEntity?(entity: Entity, location: LocationSpec, emit: CatalogProcessorEmit, originLocation: LocationSpec, cache: CatalogProcessorCache): Promise<Entity>;
    validateEntityKind?(entity: Entity): Promise<boolean>;
    postProcessEntity?(entity: Entity, location: LocationSpec, emit: CatalogProcessorEmit, cache: CatalogProcessorCache): Promise<Entity>;
};

References: LocationSpec, CatalogProcessorEmit, CatalogProcessorParser, CatalogProcessorCache, Entity