Max

@tsed/schema

Usage

import { Max } from "@tsed/schema";

See /packages/specs/schema/src/types/decorators/common/maximum.ts.

Overview

const Max: import("../../utils/withErrorMsg.js").ErrorChainedDecorator<(maximum: number, exclusive?: boolean) => (...args: any[]) => any>;

Description

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

For v6 user, use Maximum from @tsed/schema instead of @tsed/platform-http.

Example

With primitive type

class Model {
   @Max(10)
   property: number;
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "number",
      "maximum": 10
    }
  }
}

With array type

class Model {
   @Max(10)
   @CollectionOf(Number)
   property: number[];
}

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
         "type": "number",
         "maximum": 10
      }
    }
  }
}