UNPKG

swagger-auto-generate

Version:

Automatically generate Swagger JSDoc documentation for Express applications

31 lines 765 B
import { SwaggerAutoConfig } from './types'; export declare class SwaggerAuto { private config; private fileScanner; constructor(config: SwaggerAutoConfig); /** * Generate Swagger documentation */ generate(): Promise<void>; /** * Get the output file path, always inside 'swagger-docs' unless absolute */ private getOutputFilePath; /** * Save output to file */ private saveOutput; /** * Convert JSON to YAML */ private convertToYaml; /** * Watch for file changes and regenerate documentation */ watch(): Promise<void>; /** * Generate JSDoc comments for routes */ generateJSDocComments(): Promise<void>; } //# sourceMappingURL=SwaggerAuto.d.ts.map