Class Preparers

Collection of docs preparers (dir and url)

Implements

PreparerBuilder

Index

Constructors

Methods

get register fromConfig

Constructors

constructor

new Preparers(): Preparers
Returns Preparers

Methods

get

get(entity: Entity): PreparerBase
Returns the preparer for a given TechDocs entity
Parameters
- entity: Entity
  A TechDocs entity instance
Returns PreparerBase
Implementation of PreparerBuilder.get
- Defined in plugins/techdocs-node/src/stages/prepare/preparers.ts:81

register

register(protocol: RemoteProtocol, preparer: PreparerBase): void
Register a preparer in the preparers collection
Parameters
- protocol: RemoteProtocol
  url or dir to associate with preparer
- preparer: PreparerBase
  The preparer instance to set
Returns void
Implementation of PreparerBuilder.register
- Defined in plugins/techdocs-node/src/stages/prepare/preparers.ts:72

`Static`fromConfig

fromConfig(
backstageConfig: Config,
options: PreparerConfig,
): Promise<PreparerBuilder>
Returns a generators instance containing a generator for TechDocs
Parameters
- backstageConfig: Config
  A Backstage configuration
- options: PreparerConfig
Returns Promise<PreparerBuilder>
- Defined in plugins/techdocs-node/src/stages/prepare/preparers.ts:42