nestjs-swagger-dto/lib/decorators/is-number.d.ts

Nestjs swagger dto decorators

import { PropertyOptions } from '../core';
export type IsNumberProps = {
    min?: number;
    max?: number;
    /** Will convert number strings into numbers. Useful for `@Query` DTOs */
    stringified?: true;
} & ({
    type?: undefined;
    format?: 'float' | 'double';
} | {
    type: 'integer';
    format?: 'int32' | 'int64';
});
/**
 * *NOTE*: If type is not set it defaults to number
 *
 * *NOTE*: `format` is only used for OpenAPI spec
 *
 * **WARNING**: Setting `type: 'integer'` will not convert floats to integers during `classToPlain`
 */
export declare const IsNumber: ({ min, max, stringified, type, format, ...base }?: PropertyOptions<number, IsNumberProps>) => PropertyDecorator;