GeneratorRunOptions

Home > @backstage/plugin-techdocs-node > GeneratorRunOptions

The values that the generator will receive.

Signature:

export type GeneratorRunOptions = {
    inputDir: string;
    outputDir: string;
    parsedLocationAnnotation?: ParsedLocationAnnotation;
    etag?: string;
    logger: Logger;
    logStream?: Writable;
    siteOptions?: {
        name?: string;
    };
    runAsDefaultUser?: boolean;
};

References: ParsedLocationAnnotation