Skip to content

Commit

Permalink
add some jsDoc demo cases
Browse files Browse the repository at this point in the history
  • Loading branch information
plantain-00 committed Jul 26, 2017
1 parent d821b66 commit 97d53b4
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 6 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,4 @@ code | use case | description
`@minItems 1` | json schema | set `minItems = 1`
`@itemType integer` | json schema | set item `type = "integer"`
`@itemMinimum 1` | json schema | set item `minimum = 1`
`@multipleOf 10` | json schema | set `multipleOf = 10`
21 changes: 19 additions & 2 deletions demo/cases.json
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@
},
"doubleMember": {
"type": "number"
},
"multipleOfMember": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"required": [
Expand All @@ -157,7 +162,8 @@
"fixed64Member",
"sfixed64Member",
"floatMember",
"doubleMember"
"doubleMember",
"multipleOfMember"
],
"additionalProperties": false
},
Expand Down Expand Up @@ -190,12 +196,23 @@
],
"additionalProperties": false
}
},
"arrayType4": {
"type": "array",
"items": {
"type": "integer",
"minimum": 100,
"maximum": 4294967295
},
"uniqueItems": true,
"minItems": 1
}
},
"required": [
"arrayType1",
"arrayType2",
"arrayType3"
"arrayType3",
"arrayType4"
],
"additionalProperties": false
},
Expand Down
2 changes: 2 additions & 0 deletions demo/cases.proto
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,13 @@ message NumberType {
sfixed64 sfixed64Member = 12;
float floatMember = 13;
double doubleMember = 14;
uint32 multipleOfMember = 15;
}

message ArrayType {
repeated string arrayType1 = 1;
repeated TypeLiteral arrayType2 = 2;
repeated uint32 arrayType4 = 4;
}

message MapType {
Expand Down
13 changes: 13 additions & 0 deletions demo/cases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -157,12 +157,25 @@ type NumberType = {
* @type double
*/
doubleMember: number;

/**
* @type uint32
* @multipleOf 10
*/
multipleOfMember: number;
};

type ArrayType = {
arrayType1: string[];
arrayType2: TypeLiteral[];
arrayType3: { literal: number }[];
/**
* @uniqueItems
* @minItems 1
* @itemType uint32
* @itemMinimum 100
*/
arrayType4: number[];
};

type MapType = {
Expand Down
28 changes: 24 additions & 4 deletions demo/debug.json
Original file line number Diff line number Diff line change
Expand Up @@ -539,10 +539,17 @@
"kind": "number",
"type": "double"
}
},
{
"name": "multipleOfMember",
"type": {
"kind": "number",
"type": "uint32"
}
}
],
"minProperties": 14,
"maxProperties": 14
"minProperties": 15,
"maxProperties": 15
},
{
"kind": "object",
Expand Down Expand Up @@ -586,10 +593,23 @@
"maxProperties": 1
}
}
},
{
"name": "arrayType4",
"type": {
"kind": "array",
"type": {
"kind": "number",
"type": "uint32",
"minimum": 100
},
"uniqueItems": true,
"minItems": 1
}
}
],
"minProperties": 3,
"maxProperties": 3
"minProperties": 4,
"maxProperties": 4
},
{
"kind": "object",
Expand Down
1 change: 1 addition & 0 deletions src/core.ts
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,7 @@ export type NumberType = {
kind: "number";
type: string;
minimum?: number;
multipleOf?: number;
};

export type StringType = {
Expand Down

0 comments on commit 97d53b4

Please sign in to comment.