UNPKG

1.19 kBTypeScriptView Raw
1import { INestApplication } from '@nestjs/common';
2import { ApplicationConfig } from '@nestjs/core';
3import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
4import { InstanceToken, Module } from '@nestjs/core/injector/module';
5import { OpenAPIObject, SwaggerDocumentOptions } from './interfaces';
6import { ModuleRoute } from './interfaces/module-route.interface';
7import { SchemaObject } from './interfaces/open-api-spec.interface';
8export declare class SwaggerScanner {
9 private readonly transformer;
10 private readonly schemaObjectFactory;
11 private readonly explorer;
12 scanApplication(app: INestApplication, options: SwaggerDocumentOptions): Omit<OpenAPIObject, 'openapi' | 'info'>;
13 scanModuleRoutes(routes: Map<InstanceToken, InstanceWrapper>, modulePath: string | undefined, globalPrefix: string | undefined, applicationConfig: ApplicationConfig, operationIdFactory?: (controllerKey: string, methodKey: string) => string): ModuleRoute[];
14 getModules(modulesContainer: Map<string, Module>, include: Function[]): Module[];
15 addExtraModels(schemas: Record<string, SchemaObject>, extraModels: Function[]): void;
16 private getModulePathMetadata;
17}