@tsed/common
Version:
A TypeScript Framework on top of Express
72 lines (71 loc) • 1.46 kB
TypeScript
/**
* The value of `maximum` MUST be a number, representing an inclusive upper limit for a numeric instance.
*
* If the instance is a number, then this keyword validates only if the instance is less than or exactly equal to `maximum`.
*
* ::: warning
* This decorator will be removed in v7.
* For v6 user, use @@Maximum@@ from @tsed/schema instead of @tsed/common.
* :::
*
* ## Example
* ### With primitive type
*
* ```typescript
* class Model {
* @Maximum(10)
* property: number;
* }
* ```
*
* Will produce:
*
* ```json
* {
* "type": "object",
* "properties": {
* "property": {
* "type": "number",
* "maximum": 10
* }
* }
* }
* ```
*
* ### With array type
*
* ```typescript
* class Model {
* @Maximum(10)
* @CollectionOf(Number)
* property: number[];
* }
* ```
*
* Will produce:
*
* ```json
* {
* "type": "object",
* "properties": {
* "property": {
* "type": "array",
* "items": {
* "type": "number",
* "maximum": 10
* }
* }
* }
* }
* ```
*
* @param {number} maximum The maximum value allowed
* @param {boolean} exclusive Same effect as ExclusiveMaximum decorator.
* @decorator
* @validation
* @swagger
* @schema
* @ignore
* @deprecated Since v6. Use @Maximum decorator from @tsed/schema instead of.
*/
export declare function Maximum(maximum: number, exclusive?: boolean): (...args: any[]) => any;