UNPKG

1.18 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 { SchemaObject } from './interfaces/open-api-spec.interface';
7export declare class SwaggerScanner {
8 private readonly transfomer;
9 private readonly schemaObjectFactory;
10 private readonly explorer;
11 scanApplication(app: INestApplication, options: SwaggerDocumentOptions): Omit<OpenAPIObject, 'openapi' | 'info'>;
12 scanModuleRoutes(routes: Map<InstanceToken, InstanceWrapper>, modulePath: string | undefined, globalPrefix: string | undefined, applicationConfig: ApplicationConfig, operationIdFactory?: (controllerKey: string, methodKey: string) => string): Array<Omit<OpenAPIObject, 'openapi' | 'info'> & Record<'root', any>>;
13 getModules(modulesContainer: Map<string, Module>, include: Function[]): Module[];
14 addExtraModels(schemas: Record<string, SchemaObject>, extraModels: Function[]): void;
15 private getModulePathMetadata;
16}