Exporting interface and adding docs

This makes the api reporter happy, with good reason

Signed-off-by: Nikolas Skoufis <nskoufis@seek.com.au>
This commit is contained in:
Nikolas Skoufis
2022-03-01 09:18:44 +11:00
parent 55031596f2
commit 588445b175
4 changed files with 13 additions and 4 deletions
+1
View File
@@ -25,6 +25,7 @@ export type {
RouterOptions,
RecommendedDeploymentOptions,
OutOfTheBoxDeploymentOptions,
DocsBuildStrategy,
} from './service';
export { DefaultTechDocsCollator } from './search';
@@ -16,6 +16,11 @@
import { Entity } from '@backstage/catalog-model';
import { Config } from '@backstage/config';
/**
* A strategy for when to build TechDocs locally, and when to skip building TechDocs (allowing for an external build)
*
* @public
*/
export interface DocsBuildStrategy {
shouldBuild(entity: Entity): Promise<boolean>;
}
@@ -20,3 +20,4 @@ export type {
RecommendedDeploymentOptions,
OutOfTheBoxDeploymentOptions,
} from './router';
export type { DocsBuildStrategy } from './DocsBuildStrategy';