UNPKG

@nestjs/swagger

Version:

Nest - modern, fast, powerful node.js web framework (@swagger)

15 lines (14 loc) 652 B
import { Type } from '@nestjs/common'; import { ParameterObject, SchemaObject } from '../interfaces/open-api-spec.interface'; import { SwaggerEnumType } from '../types/swagger-enum.type'; declare type ParameterOptions = Omit<ParameterObject, 'in' | 'schema'>; interface ApiParamMetadata extends ParameterOptions { type?: Type<unknown> | Function | [Function] | string; enum?: SwaggerEnumType; } interface ApiParamSchemaHost extends ParameterOptions { schema: SchemaObject; } export declare type ApiParamOptions = ApiParamMetadata | ApiParamSchemaHost; export declare function ApiParam(options: ApiParamOptions): MethodDecorator; export {};