PreparerBase

Home > @backstage/plugin-techdocs-node > PreparerBase

Definition of a TechDocs preparer

Signature:

export type PreparerBase = {
    prepare(entity: Entity, options?: PreparerOptions): Promise<PreparerResponse>;
    shouldCleanPreparedDirectory(): boolean;
};

References: Entity, PreparerOptions, PreparerResponse