refactor(techdocs): deprecate ShouldBuildParameters type

Signed-off-by: Phil Kuang <pkuang@factset.com>

plugins/techdocs-node/api-report.md

@@ -28,7 +28,7 @@ export class DirectoryPreparer implements PreparerBase {
 // @public
 export interface DocsBuildStrategy {
   // (undocumented)
-  shouldBuild(params: ShouldBuildParameters): Promise<boolean>;
+  shouldBuild(params: { entity: Entity }): Promise<boolean>;
 }
 
 // @public
@@ -233,11 +233,6 @@ export type ReadinessResponse = {
 // @public
 export type RemoteProtocol = 'url' | 'dir';
 
-// @public
-export type ShouldBuildParameters = {
-  entity: Entity;
-};
-
 // @public
 export type SupportedGeneratorKey = 'techdocs' | string;
 

plugins/techdocs-node/src/techdocsTypes.ts

@@ -48,20 +48,11 @@ export interface TechDocsDocument extends IndexableDocument {
   path: string;
 }
 
-/**
- * Parameters passed to the shouldBuild method on the DocsBuildStrategy interface
- *
- * @public
- */
-export type ShouldBuildParameters = {
-  entity: Entity;
-};
-
 /**
  * A strategy for when to build TechDocs locally, and when to skip building TechDocs (allowing for an external build)
  *
  * @public
  */
 export interface DocsBuildStrategy {
-  shouldBuild(params: ShouldBuildParameters): Promise<boolean>;
+  shouldBuild(params: { entity: Entity }): Promise<boolean>;
 }