UNPKG

696 BTypeScriptView Raw
1import { Type } from '@nestjs/common';
2import { ParameterObject, SchemaObject } from '../interfaces/open-api-spec.interface';
3import { SwaggerEnumType } from '../types/swagger-enum.type';
4declare type ParameterOptions = Omit<ParameterObject, 'in' | 'schema'>;
5interface ApiParamMetadata extends ParameterOptions {
6 type?: Type<unknown> | Function | [Function] | string;
7 format?: string;
8 enum?: SwaggerEnumType;
9 enumName?: string;
10}
11interface ApiParamSchemaHost extends ParameterOptions {
12 schema: SchemaObject;
13}
14export declare type ApiParamOptions = ApiParamMetadata | ApiParamSchemaHost;
15export declare function ApiParam(options: ApiParamOptions): MethodDecorator;
16export {};