Interface TechdocsPublisherExtensionPoint

Extension point type for configuring a custom TechDocs publisher

interface TechdocsPublisherExtensionPoint {
    registerPublisher(type: PublisherType, publisher: PublisherBase): void;
    registerPublisherSettings<T extends "googleGcs">(
        publisher: T,
        settings: PublisherSettings[T],
    ): void;
}

Index

Methods

registerPublisher registerPublisherSettings

Methods

registerPublisher

registerPublisher(type: PublisherType, publisher: PublisherBase): void
Parameters
- type: PublisherType
- publisher: PublisherBase
Returns void
- Defined in plugins/techdocs-node/src/extensions.ts:92

registerPublisherSettings

registerPublisherSettings<T extends "googleGcs">(
publisher: T,
settings: PublisherSettings[T],
): void
Type Parameters
- T extends "googleGcs"
Parameters
- publisher: T
- settings: PublisherSettings[T]
Returns void
- Defined in plugins/techdocs-node/src/extensions.ts:93