# Maximum Decorator

Module
import { Maximum } from "@tsed/common"
Source/packages/common/src/jsonschema/decorators/maximum.ts

# Overview

function Maximum(maximum: number, exclusive?: boolean): (...parameters: 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.

# Example

# With primitive type

class Model {
   @Maximum(10)
   property: number;
}
1
2
3
4

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "number",
      "maximum": 10
    }
  }
}
1
2
3
4
5
6
7
8
9

# With array type

class Model {
   @Maximum(10)
   @PropertyType(Number)
   property: number[];
}
1
2
3
4
5

Will produce:

{
  "type": "object",
  "properties": {
    "property": {
      "type": "array",
      "items": {
         "type": "number",
         "maximum": 10
      }
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12