@progress/kendo-typescript-api-tasks 1.0.1-dev.1531

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/README.md +11 -0
  2. package/index.js +70 -0
  3. package/jest.config.js +3 -0
  4. package/lib/class-page.hbs +27 -0
  5. package/lib/class-page.js +35 -0
  6. package/lib/code-block.hbs +7 -0
  7. package/lib/comment-tags.hbs +7 -0
  8. package/lib/comment.js +56 -0
  9. package/lib/component-page.hbs +101 -0
  10. package/lib/component-page.js +67 -0
  11. package/lib/constant-page.hbs +4 -0
  12. package/lib/constant-page.js +15 -0
  13. package/lib/constructor.hbs +21 -0
  14. package/lib/enum-page.hbs +11 -0
  15. package/lib/enum-page.js +25 -0
  16. package/lib/fn-page.hbs +18 -0
  17. package/lib/fn-page.js +24 -0
  18. package/lib/generator.js +264 -0
  19. package/lib/index-page.hbs +54 -0
  20. package/lib/index-page.js +15 -0
  21. package/lib/is-constructor.js +9 -0
  22. package/lib/is-event.js +7 -0
  23. package/lib/is-field.js +7 -0
  24. package/lib/is-input.js +7 -0
  25. package/lib/is-method.js +10 -0
  26. package/lib/is-public.js +8 -0
  27. package/lib/map-constructors.js +30 -0
  28. package/lib/map-methods.js +23 -0
  29. package/lib/map-props.js +63 -0
  30. package/lib/member-meta.hbs +7 -0
  31. package/lib/member-page.js +41 -0
  32. package/lib/methods.hbs +109 -0
  33. package/lib/property.hbs +38 -0
  34. package/lib/react/component-page.hbs +26 -0
  35. package/lib/react/component-page.js +30 -0
  36. package/lib/return-type.js +30 -0
  37. package/lib/slug.js +9 -0
  38. package/lib/template-utils.js +40 -0
  39. package/lib/type-utils.js +179 -0
  40. package/lib/union-page.hbs +14 -0
  41. package/lib/union-page.js +17 -0
  42. package/lib/utils.js +40 -0
  43. package/lib/warn.js +22 -0
  44. package/lib/warning-rules.js +14 -0
  45. package/package.json +43 -0
  46. package/test/api.js +339 -0
  47. package/test/class.json +73 -0
  48. package/test/components-def.json +98 -0
  49. package/test/events-def.json +163 -0
  50. package/test/fields-def.json +203 -0
  51. package/test/fn-def.json +80 -0
  52. package/test/fn.json +89 -0
  53. package/test/inputs-def.json +98 -0
  54. package/test/interface-comments.json +412 -0
  55. package/test/intersection.json +67 -0
  56. package/test/package.json +175 -0
  57. package/test/type-union-operators.json +42 -0
  58. package/test/type-union.json +70 -0
  59. package/test/warning.js +91 -0
  60. package/type-links.json +3 -0
@@ -0,0 +1,412 @@
1
+ {
2
+ "id": 0,
3
+ "name": "package-name",
4
+ "kind": 0,
5
+ "flags": {},
6
+ "children": [
7
+ {
8
+ "id": 68,
9
+ "name": "\"src/base.d\"",
10
+ "kind": 1,
11
+ "kindString": "External module",
12
+ "flags": {
13
+ "isExported": true
14
+ },
15
+ "children": [
16
+ {
17
+ "id": 1139,
18
+ "name": "Base",
19
+ "kind": 256,
20
+ "kindString": "Interface",
21
+ "flags": {
22
+ "isExported": true
23
+ },
24
+ "comment": {
25
+ "shortText": "An interface"
26
+ },
27
+ "typeParameter": [
28
+ {
29
+ "id": 1140,
30
+ "name": "T",
31
+ "kind": 131072,
32
+ "kindString": "Type parameter",
33
+ "flags": {}
34
+ }
35
+ ],
36
+ "children": [
37
+ {
38
+ "id": 1141,
39
+ "name": "foo",
40
+ "kind": 2048,
41
+ "kindString": "Method",
42
+ "flags": {
43
+ "isExported": true
44
+ },
45
+ "comment": {
46
+ "shortText": "METHOD_DESC"
47
+ },
48
+ "signatures": [
49
+ {
50
+ "id": 1142,
51
+ "name": "foo",
52
+ "kind": 4096,
53
+ "kindString": "Call signature",
54
+ "flags": {},
55
+ "comment": {
56
+ "shortText": "SIG_DESC",
57
+ "returns": "The current instance to allow chaining.\n"
58
+ },
59
+ "parameters": [
60
+ {
61
+ "id": 1143,
62
+ "name": "param",
63
+ "kind": 32768,
64
+ "kindString": "Parameter",
65
+ "flags": {},
66
+ "comment": {
67
+ "text": "PARAM_DESC"
68
+ },
69
+ "type": {
70
+ "type": "instrinct",
71
+ "name": "string"
72
+ }
73
+ }
74
+ ],
75
+ "type": {
76
+ "type": "typeParameter",
77
+ "name": "T"
78
+ }
79
+ }
80
+ ],
81
+ "sources": [
82
+ {
83
+ "fileName": "src/base.d.ts",
84
+ "line": 34,
85
+ "character": 6
86
+ }
87
+ ]
88
+ }
89
+ ],
90
+ "groups": [
91
+ {
92
+ "title": "Methods",
93
+ "kind": 2048,
94
+ "children": [
95
+ 1141
96
+ ]
97
+ }
98
+ ],
99
+ "sources": [
100
+ {
101
+ "fileName": "src/base.d.ts",
102
+ "line": 26,
103
+ "character": 22
104
+ }
105
+ ],
106
+ "implementedBy": [
107
+ {
108
+ "type": "reference",
109
+ "name": "Child",
110
+ "id": 519
111
+ }
112
+ ]
113
+ }
114
+ ]
115
+ },
116
+ {
117
+ "id": 561,
118
+ "name": "\"src/impl.d\"",
119
+ "kind": 1,
120
+ "kindString": "External module",
121
+ "flags": {
122
+ "isExported": true
123
+ },
124
+ "children": [
125
+ {
126
+ "id": 562,
127
+ "name": "Impl",
128
+ "kind": 128,
129
+ "kindString": "Class",
130
+ "flags": {
131
+ "isExported": true
132
+ },
133
+ "comment": {
134
+ "shortText": "An impl"
135
+ },
136
+ "children": [
137
+ {
138
+ "id": 571,
139
+ "name": "foo",
140
+ "kind": 2048,
141
+ "kindString": "Method",
142
+ "flags": {
143
+ "isExported": true
144
+ },
145
+ "signatures": [
146
+ {
147
+ "id": 572,
148
+ "name": "foo",
149
+ "kind": 4096,
150
+ "kindString": "Call signature",
151
+ "flags": {},
152
+ "parameters": [
153
+ {
154
+ "id": 573,
155
+ "name": "param",
156
+ "kind": 32768,
157
+ "kindString": "Parameter",
158
+ "flags": {},
159
+ "type": {
160
+ "type": "instrinct",
161
+ "name": "string"
162
+ }
163
+ }
164
+ ],
165
+ "type": {
166
+ "type": "reference",
167
+ "name": "Impl",
168
+ "id": 562
169
+ },
170
+ "implementationOf": {
171
+ "type": "reference",
172
+ "name": "Base.foo",
173
+ "id": 1142
174
+ }
175
+ }
176
+ ],
177
+ "sources": [
178
+ {
179
+ "fileName": "src/impl.d.ts",
180
+ "line": 30,
181
+ "character": 6
182
+ }
183
+ ],
184
+ "implementationOf": {
185
+ "type": "reference",
186
+ "name": "Base.foo",
187
+ "id": 1141
188
+ }
189
+ }
190
+ ],
191
+ "groups": [
192
+ {
193
+ "title": "Constructors",
194
+ "kind": 512,
195
+ "children": [
196
+ 563
197
+ ]
198
+ },
199
+ {
200
+ "title": "Properties",
201
+ "kind": 1024,
202
+ "children": [
203
+ 580
204
+ ]
205
+ },
206
+ {
207
+ "title": "Methods",
208
+ "kind": 2048,
209
+ "children": [
210
+ 581,
211
+ 583,
212
+ 587,
213
+ 589,
214
+ 571,
215
+ 567,
216
+ 592,
217
+ 575,
218
+ 596,
219
+ 600
220
+ ]
221
+ }
222
+ ],
223
+ "sources": [
224
+ {
225
+ "fileName": "src/impl.d.ts",
226
+ "line": 7,
227
+ "character": 19
228
+ }
229
+ ],
230
+ "implementedTypes": [
231
+ {
232
+ "type": "reference",
233
+ "name": "Base",
234
+ "id": 1139,
235
+ "typeArguments": [
236
+ {
237
+ "type": "reference",
238
+ "name": "Impl",
239
+ "id": 562
240
+ }
241
+ ]
242
+ }
243
+ ]
244
+ }
245
+ ],
246
+ "groups": [
247
+ {
248
+ "title": "Classes",
249
+ "kind": 128,
250
+ "children": [
251
+ 562
252
+ ]
253
+ }
254
+ ],
255
+ "sources": [
256
+ {
257
+ "fileName": "src/impl.d.ts",
258
+ "line": 1,
259
+ "character": 0
260
+ }
261
+ ]
262
+ },
263
+ {
264
+ "id": 1561,
265
+ "name": "\"src/impl2.d\"",
266
+ "kind": 1,
267
+ "kindString": "External module",
268
+ "flags": {
269
+ "isExported": true
270
+ },
271
+ "children": [
272
+ {
273
+ "id": 1562,
274
+ "name": "Impl2",
275
+ "kind": 128,
276
+ "kindString": "Class",
277
+ "flags": {
278
+ "isExported": true
279
+ },
280
+ "comment": {
281
+ "shortText": "IMPL_COMMENT"
282
+ },
283
+ "children": [
284
+ {
285
+ "id": 1571,
286
+ "name": "foo",
287
+ "kind": 2048,
288
+ "kindString": "Method",
289
+ "flags": {
290
+ "isExported": true
291
+ },
292
+ "signatures": [
293
+ {
294
+ "id": 1572,
295
+ "name": "foo",
296
+ "kind": 4096,
297
+ "kindString": "Call signature",
298
+ "flags": {},
299
+ "comment": {
300
+ "shortText": "IMPL_SIG_DESC",
301
+ "returns": "The current instance to allow chaining.\n"
302
+ },
303
+ "parameters": [
304
+ {
305
+ "id": 1573,
306
+ "name": "param",
307
+ "kind": 32768,
308
+ "kindString": "Parameter",
309
+ "flags": {},
310
+ "comment": {
311
+ "text": "IMPL_PARAM_DESC"
312
+ },
313
+ "type": {
314
+ "type": "instrinct",
315
+ "name": "string"
316
+ }
317
+ }
318
+ ],
319
+ "type": {
320
+ "type": "typeParameter",
321
+ "name": "T"
322
+ }
323
+ }
324
+ ],
325
+ "sources": [
326
+ {
327
+ "fileName": "src/impl2.d.ts",
328
+ "line": 30,
329
+ "character": 6
330
+ }
331
+ ],
332
+ "implementationOf": {
333
+ "type": "reference",
334
+ "name": "Base.foo",
335
+ "id": 1141
336
+ }
337
+ }
338
+ ],
339
+ "groups": [
340
+ {
341
+ "title": "Constructors",
342
+ "kind": 1512,
343
+ "children": [
344
+ 1563
345
+ ]
346
+ },
347
+ {
348
+ "title": "Properties",
349
+ "kind": 1024,
350
+ "children": [
351
+ 1580
352
+ ]
353
+ },
354
+ {
355
+ "title": "Methods",
356
+ "kind": 2048,
357
+ "children": [
358
+ 1581,
359
+ 1583,
360
+ 1587,
361
+ 1589,
362
+ 1571,
363
+ 1567,
364
+ 1592,
365
+ 1575,
366
+ 1596,
367
+ 1600
368
+ ]
369
+ }
370
+ ],
371
+ "sources": [
372
+ {
373
+ "fileName": "src/impl.d.ts",
374
+ "line": 7,
375
+ "character": 19
376
+ }
377
+ ],
378
+ "implementedTypes": [
379
+ {
380
+ "type": "reference",
381
+ "name": "Base",
382
+ "id": 1139,
383
+ "typeArguments": [
384
+ {
385
+ "type": "reference",
386
+ "name": "Impl",
387
+ "id": 1562
388
+ }
389
+ ]
390
+ }
391
+ ]
392
+ }
393
+ ],
394
+ "groups": [
395
+ {
396
+ "title": "Classes",
397
+ "kind": 128,
398
+ "children": [
399
+ 1562
400
+ ]
401
+ }
402
+ ],
403
+ "sources": [
404
+ {
405
+ "fileName": "src/impl.d.ts",
406
+ "line": 1,
407
+ "character": 0
408
+ }
409
+ ]
410
+ }
411
+ ]
412
+ }
@@ -0,0 +1,67 @@
1
+ {
2
+ "name": "SortSettings",
3
+ "kindString": "Type alias",
4
+ "flags": {
5
+ "isExported": true
6
+ },
7
+ "comment": {
8
+ "shortText": "Sets the sort settings of the Grid."
9
+ },
10
+ "type": {
11
+ "type": "union",
12
+ "types": [
13
+ {
14
+ "type": "intrinsic",
15
+ "name": "boolean"
16
+ },
17
+ {
18
+ "type": "intersection",
19
+ "types": [
20
+ {
21
+ "type": "reference",
22
+ "name": "ColumnSortSettings",
23
+ "id": 83
24
+ },
25
+ {
26
+ "type": "reflection",
27
+ "declaration": {
28
+ "id": 87,
29
+ "name": "__type",
30
+ "kind": 65536,
31
+ "kindString": "Type literal",
32
+ "flags": {},
33
+ "children": [
34
+ {
35
+ "id": 88,
36
+ "name": "mode",
37
+ "kind": 32,
38
+ "kindString": "Variable",
39
+ "flags": {
40
+ "isOptional": true
41
+ },
42
+ "comment": {
43
+ "shortText": "The sort mode of the Grid. The available modes for sorting are:\n- `single`\n- `multiple`"
44
+ },
45
+ "type": {
46
+ "type": "union",
47
+ "types": [
48
+ {
49
+ "type": "literal",
50
+ "value": "single"
51
+ },
52
+ {
53
+ "type": "literal",
54
+ "value": "multiple"
55
+ }
56
+ ]
57
+ }
58
+ }
59
+ ]
60
+ }
61
+ }
62
+ ]
63
+ }
64
+ ]
65
+ }
66
+ }
67
+
@@ -0,0 +1,175 @@
1
+ {
2
+ "id": 0,
3
+ "name": "package-name",
4
+ "kind": 0,
5
+ "flags": {},
6
+ "children": [
7
+ {
8
+ "id": 68,
9
+ "name": "\"src/module1/foo.d\"",
10
+ "kind": 1,
11
+ "kindString": "External module",
12
+ "flags": {
13
+ "isExported": true
14
+ },
15
+ "children": [
16
+ {
17
+ "id": 69,
18
+ "name": "Foo",
19
+ "kind": 128,
20
+ "kindString": "Class",
21
+ "flags": {
22
+ "isExported": true
23
+ },
24
+ "comment": {
25
+ "shortText": "Foo in Module1."
26
+ },
27
+ "children": [
28
+ {
29
+ "id": 72,
30
+ "name": "constructor",
31
+ "kind": 512,
32
+ "kindString": "Constructor",
33
+ "flags": {
34
+ "isExported": true
35
+ },
36
+ "comment": {
37
+ "shortText": "Create a Module1 Foo."
38
+ },
39
+ "signatures": [
40
+ {
41
+ "id": 73,
42
+ "name": "new Foo",
43
+ "kind": 16384,
44
+ "kindString": "Constructor signature",
45
+ "flags": {},
46
+ "comment": {
47
+ "shortText": "Create a Module1 Foo."
48
+ },
49
+ "type": {
50
+ "type": "reference",
51
+ "name": "Foo",
52
+ "id": 69
53
+ }
54
+ }
55
+ ],
56
+ "sources": [
57
+ {
58
+ "fileName": "src/module1/foo.d.ts",
59
+ "line": 15,
60
+ "character": 17
61
+ }
62
+ ]
63
+ }
64
+ ],
65
+ "sources": [
66
+ {
67
+ "fileName": "src/module1/foo.d.ts",
68
+ "line": 6,
69
+ "character": 19
70
+ }
71
+ ]
72
+ }
73
+ ],
74
+ "sources": [
75
+ {
76
+ "fileName": "src/module1/foo.d.ts",
77
+ "line": 1,
78
+ "character": 0
79
+ }
80
+ ]
81
+ },
82
+ {
83
+ "id": 561,
84
+ "name": "\"src/foo.d\"",
85
+ "kind": 1,
86
+ "kindString": "External module",
87
+ "flags": {
88
+ "isExported": true
89
+ },
90
+ "children": [
91
+ {
92
+ "id": 562,
93
+ "name": "Foo",
94
+ "kind": 128,
95
+ "kindString": "Class",
96
+ "flags": {
97
+ "isExported": true
98
+ },
99
+ "comment": {
100
+ "shortText": "Foo"
101
+ },
102
+ "children": [
103
+ {
104
+ "id": 563,
105
+ "name": "constructor",
106
+ "kind": 512,
107
+ "kindString": "Constructor",
108
+ "flags": {
109
+ "isExported": true
110
+ },
111
+ "comment": {
112
+ "shortText": "Creates a Foo"
113
+ },
114
+ "signatures": [
115
+ {
116
+ "id": 564,
117
+ "name": "new Foo",
118
+ "kind": 16384,
119
+ "kindString": "Constructor signature",
120
+ "flags": {},
121
+ "comment": {
122
+ "shortText": "Creates a Foo"
123
+ },
124
+ "parameters": [
125
+ {
126
+ "id": 565,
127
+ "name": "param1",
128
+ "kind": 32768,
129
+ "kindString": "Parameter",
130
+ "flags": {},
131
+ "comment": {
132
+ "shortText": "The foo."
133
+ },
134
+ "type": {
135
+ "type": "reference",
136
+ "name": "Circle",
137
+ "id": 69
138
+ }
139
+ }
140
+ ],
141
+ "type": {
142
+ "type": "reference",
143
+ "name": "Foo",
144
+ "id": 562
145
+ }
146
+ }
147
+ ],
148
+ "sources": [
149
+ {
150
+ "fileName": "src/foo.d.ts",
151
+ "line": 7,
152
+ "character": 43
153
+ }
154
+ ]
155
+ }
156
+ ],
157
+ "sources": [
158
+ {
159
+ "fileName": "src/foo.d.ts",
160
+ "line": 7,
161
+ "character": 19
162
+ }
163
+ ]
164
+ }
165
+ ],
166
+ "sources": [
167
+ {
168
+ "fileName": "src/foo.d.ts",
169
+ "line": 1,
170
+ "character": 0
171
+ }
172
+ ]
173
+ }
174
+ ]
175
+ }