-
-
Notifications
You must be signed in to change notification settings - Fork 286
/
exclusiveMinimum.ts
70 lines (69 loc) · 1.4 KB
/
exclusiveMinimum.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
import {Minimum} from "./minimum";
/**
* The value of `exclusiveMinimum` MUST be number, representing an exclusive upper limit for a numeric instance.
*
* If the instance is a number, then the instance is valid only if it has a value strictly greater than (not equal to) `exclusiveMinimum`.
*
* ## Example
* ### With primitive type
*
* ```typescript
* class Model {
* @ExclusiveMinimum(10)
* property: number;
* }
* ```
*
* Will produce:
*
* ```json
* {
* "type": "object",
* "properties": {
* "property": {
* "type": "number",
* "exclusiveMinimum": 10
* }
* }
* }
* ```
*
* ### With array type
*
* ```typescript
* class Model {
* @ExclusiveMinimum(10)
* @PropertyType(Number)
* property: number[];
* }
* ```
*
* Will produce:
*
* ```json
* {
* "type": "object",
* "properties": {
* "property": {
* "type": "array",
* "items": {
* "type": "number",
* "exclusiveMinimum": 10
* }
* }
* }
* }
* ```
*
* @param minimum
* @param {boolean} exclusiveMinimum
* @returns {Function}
* @decorator
* @ajv
* @jsonschema
* @property
* @auto-map The data will be stored on the right place according to the type and collectionType (primitive or collection).
*/
export function ExclusiveMinimum(minimum: number, exclusiveMinimum: boolean = true) {
return Minimum(minimum, exclusiveMinimum);
}