Class Publisher

Factory class to create a TechDocs publisher based on defined publisher type in app config. Uses techdocs.publisher.type.

Implements

PublisherBuilder

Index

Constructors

Methods

get register fromConfig

Constructors

constructor

new Publisher(): Publisher
Returns Publisher

Methods

get

get(config: Config): PublisherBase
Parameters
- config: Config
Returns PublisherBase
Implementation of PublisherBuilder.get
- Defined in plugins/techdocs-node/src/stages/publish/publish.ts:43

register

register(type: PublisherType | "techdocs", publisher: PublisherBase): void
Parameters
- type: PublisherType | "techdocs"
- publisher: PublisherBase
Returns void
Implementation of PublisherBuilder.register
- Defined in plugins/techdocs-node/src/stages/publish/publish.ts:39

`Static`fromConfig

fromConfig(config: Config, options: PublisherFactory): Promise<PublisherBase>
Returns a instance of TechDocs publisher
Parameters
- config: Config
  A Backstage configuration
- options: PublisherFactory
  Options for configuring the publisher factory
Returns Promise<PublisherBase>
- Defined in plugins/techdocs-node/src/stages/publish/publish.ts:67