@nestjs/swagger
Version:
Nest - modern, fast, powerful node.js web framework (@swagger)
16 lines (15 loc) • 675 B
TypeScript
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 ApiQueryMetadata extends ParameterOptions {
type?: Type<unknown> | Function | [Function] | string;
isArray?: boolean;
enum?: SwaggerEnumType;
}
interface ApiQuerySchemaHost extends ParameterOptions {
schema: SchemaObject;
}
export declare type ApiQueryOptions = ApiQueryMetadata | ApiQuerySchemaHost;
export declare function ApiQuery(options: ApiQueryOptions): MethodDecorator;
export {};