UNPKG

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