Type Alias PreparerBase

Definition of a TechDocs preparer

type PreparerBase = {
    prepare(
        entity: Entity,
        options?: PreparerOptions,
    ): Promise<PreparerResponse>;
    shouldCleanPreparedDirectory(): boolean;
}

Implemented by

Index

Methods

prepare shouldCleanPreparedDirectory

Methods

prepare

prepare(entity: Entity, options?: PreparerOptions): Promise<PreparerResponse>
Given an Entity definition from the Software Catalog, go and prepare a directory with contents from the location in temporary storage and return the path.
Parameters
- entity: Entity
  The entity from the Software Catalog
- Optionaloptions: PreparerOptions
  If etag is provided, it will be used to check if the target has updated since the last build.
Returns Promise<PreparerResponse>
Throws
NotModifiedError when the prepared directory has not been changed since the last build.
- Defined in plugins/techdocs-node/src/stages/prepare/types.ts:79

shouldCleanPreparedDirectory

shouldCleanPreparedDirectory(): boolean
Indicates whether the prepared directory should be cleaned after generation.

Returns boolean
- Defined in plugins/techdocs-node/src/stages/prepare/types.ts:84