UNPKG

nest-redoc

Version:

A NestJS Frontend for your OpenAPI Specs powered by ReDoc

15 lines (14 loc) 816 B
import { INestApplication } from "@nestjs/common"; import { RedocOptions } from "./interfaces/redoc-options.interface"; import { DeepPartial } from "./redoc.utils"; import { DocumentBuilder, OpenAPIObject } from "@nestjs/swagger"; import { SwaggerDocumentOptions } from "@nestjs/swagger/dist/interfaces"; export declare class RedocModule { static setup(path: string, app: INestApplication, document: OpenAPIObject, options?: DeepPartial<RedocOptions>): Promise<void>; static createDocumentBuilder(): DocumentBuilder; static createDocument(app: INestApplication, config: Omit<OpenAPIObject, 'paths'>, options?: SwaggerDocumentOptions): OpenAPIObject; private static buildDocument; private static validateOptions; private static renderHandlebars; private static compileHandlebarTemplate; }