-
Notifications
You must be signed in to change notification settings - Fork 27
/
schema.json
1139 lines (1138 loc) · 47.6 KB
/
schema.json
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"Attribute": {
"properties": {
"default": {
"description": "The default value of the attribute, if any.\n\nAs attributes are always strings, this is the actual value, not a human\nreadable description.",
"type": "string"
},
"deprecated": {
"description": "Whether the attribute is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"fieldName": {
"description": "The name of the field this attribute is associated with, if any.",
"type": "string"
},
"inheritedFrom": {
"$ref": "#/definitions/Reference"
},
"name": {
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The type that the attribute will be serialized/deserialized as."
}
},
"required": [
"name"
],
"type": "object"
},
"ClassDeclaration": {
"properties": {
"deprecated": {
"description": "Whether the class or mixin is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the class.",
"type": "string"
},
"kind": {
"enum": [
"class"
],
"type": "string"
},
"members": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/ClassField"
},
{
"$ref": "#/definitions/ClassMethod"
}
]
},
"type": "array"
},
"mixins": {
"description": "Any class mixins applied in the extends clause of this class.\n\nIf mixins are applied in the class definition, then the true superclass\nof this class is the result of applying mixins in order to the superclass.\n\nMixins must be listed in order of their application to the superclass or\nprevious mixin application. This means that the innermost mixin is listed\nfirst. This may read backwards from the common order in JavaScript, but\nmatches the order of language used to describe mixin application, like\n\"S with A, B\".",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"name": {
"type": "string"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"superclass": {
"$ref": "#/definitions/Reference",
"description": "The superclass of this class.\n\nIf this class is defined with mixin applications, the prototype chain\nincludes the mixin applications and the true superclass is computed\nfrom them."
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ClassField": {
"properties": {
"default": {
"type": "string"
},
"deprecated": {
"description": "Whether the property is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the field.",
"type": "string"
},
"inheritedFrom": {
"$ref": "#/definitions/Reference"
},
"kind": {
"enum": [
"field"
],
"type": "string"
},
"name": {
"type": "string"
},
"privacy": {
"$ref": "#/definitions/Privacy"
},
"readonly": {
"description": "Whether the property is read-only.",
"type": "boolean"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"static": {
"type": "boolean"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"ClassMethod": {
"properties": {
"deprecated": {
"description": "Whether the function is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"inheritedFrom": {
"$ref": "#/definitions/Reference"
},
"kind": {
"enum": [
"method"
],
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/definitions/Parameter"
},
"type": "array"
},
"privacy": {
"$ref": "#/definitions/Privacy"
},
"return": {
"properties": {
"description": {
"description": "A markdown description.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"type": "object"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"static": {
"type": "boolean"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"CssCustomProperty": {
"properties": {
"default": {
"type": "string"
},
"deprecated": {
"description": "Whether the CSS custom property is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"name": {
"description": "The name of the property, including leading `--`.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"syntax": {
"description": "The expected syntax of the defined property. Defaults to \"*\".\n\nThe syntax must be a valid CSS [syntax string](https://developer.mozilla.org/en-US/docs/Web/CSS/@property/syntax)\nas defined in the CSS Properties and Values API.\n\nExamples:\n\n\"<color>\": accepts a color\n\"<length> | <percentage>\": accepts lengths or percentages but not calc expressions with a combination of the two\n\"small | medium | large\": accepts one of these values set as custom idents.\n\"*\": any valid token",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"CssCustomState": {
"description": "The description of a CSS Custom State\nhttps://developer.mozilla.org/en-US/docs/Web/API/CustomStateSet",
"properties": {
"deprecated": {
"description": "Whether the CSS custom state is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"name": {
"description": "The name of the state. Note: Unlike CSS custom properties, custom states\ndo not have a leading `--`.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"CssPart": {
"description": "The description of a CSS Part",
"properties": {
"deprecated": {
"description": "Whether the CSS shadow part is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"name": {
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"CustomElementDeclaration": {
"description": "A description of a custom element class.\n\nCustom elements are JavaScript classes, so this extends from\n`ClassDeclaration` and adds custom-element-specific features like\nattributes, events, and slots.\n\nNote that `tagName` in this interface is optional. Tag names are not\nneccessarily part of a custom element class, but belong to the definition\n(often called the \"registration\") or the `customElements.define()` call.\n\nBecause classes and tag names can only be registered once, there's a\none-to-one relationship between classes and tag names. For ease of use,\nwe allow the tag name here.\n\nSome packages define and register custom elements in separate modules. In\nthese cases one `Module` should contain the `CustomElement` without a\ntagName, and another `Module` should contain the\n`CustomElementExport`.",
"properties": {
"attributes": {
"description": "The attributes that this element is known to understand.",
"items": {
"$ref": "#/definitions/Attribute"
},
"type": "array"
},
"cssParts": {
"items": {
"$ref": "#/definitions/CssPart"
},
"type": "array"
},
"cssProperties": {
"items": {
"$ref": "#/definitions/CssCustomProperty"
},
"type": "array"
},
"cssStates": {
"items": {
"$ref": "#/definitions/CssCustomState"
},
"type": "array"
},
"customElement": {
"description": "Distinguishes a regular JavaScript class from a\ncustom element class",
"enum": [
true
],
"type": "boolean"
},
"demos": {
"items": {
"$ref": "#/definitions/Demo"
},
"type": "array"
},
"deprecated": {
"description": "Whether the class or mixin is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the class.",
"type": "string"
},
"events": {
"description": "The events that this element fires.",
"items": {
"$ref": "#/definitions/Event"
},
"type": "array"
},
"kind": {
"enum": [
"class"
],
"type": "string"
},
"members": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/ClassField"
},
{
"$ref": "#/definitions/ClassMethod"
}
]
},
"type": "array"
},
"mixins": {
"description": "Any class mixins applied in the extends clause of this class.\n\nIf mixins are applied in the class definition, then the true superclass\nof this class is the result of applying mixins in order to the superclass.\n\nMixins must be listed in order of their application to the superclass or\nprevious mixin application. This means that the innermost mixin is listed\nfirst. This may read backwards from the common order in JavaScript, but\nmatches the order of language used to describe mixin application, like\n\"S with A, B\".",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"name": {
"type": "string"
},
"slots": {
"description": "The shadow dom content slots that this element accepts.",
"items": {
"$ref": "#/definitions/Slot"
},
"type": "array"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"superclass": {
"$ref": "#/definitions/Reference",
"description": "The superclass of this class.\n\nIf this class is defined with mixin applications, the prototype chain\nincludes the mixin applications and the true superclass is computed\nfrom them."
},
"tagName": {
"description": "An optional tag name that should be specified if this is a\nself-registering element.\n\nSelf-registering elements must also include a CustomElementExport\nin the module's exports.",
"type": "string"
}
},
"required": [
"customElement",
"kind",
"name"
],
"type": "object"
},
"CustomElementExport": {
"description": "A global custom element defintion, ie the result of a\n`customElements.define()` call.\n\nThis is represented as an export because a definition makes the element\navailable outside of the module it's defined it.",
"properties": {
"declaration": {
"$ref": "#/definitions/Reference",
"description": "A reference to the class or other declaration that implements the\ncustom element."
},
"deprecated": {
"description": "Whether the custom-element export is deprecated.\nFor example, a future version will not register the custom element in this file.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"kind": {
"enum": [
"custom-element-definition"
],
"type": "string"
},
"name": {
"description": "The tag name of the custom element.",
"type": "string"
}
},
"required": [
"declaration",
"kind",
"name"
],
"type": "object"
},
"CustomElementMixinDeclaration": {
"description": "A class mixin that also adds custom element related properties.",
"properties": {
"attributes": {
"description": "The attributes that this element is known to understand.",
"items": {
"$ref": "#/definitions/Attribute"
},
"type": "array"
},
"cssParts": {
"items": {
"$ref": "#/definitions/CssPart"
},
"type": "array"
},
"cssProperties": {
"items": {
"$ref": "#/definitions/CssCustomProperty"
},
"type": "array"
},
"cssStates": {
"items": {
"$ref": "#/definitions/CssCustomState"
},
"type": "array"
},
"customElement": {
"description": "Distinguishes a regular JavaScript class from a\ncustom element class",
"enum": [
true
],
"type": "boolean"
},
"demos": {
"items": {
"$ref": "#/definitions/Demo"
},
"type": "array"
},
"deprecated": {
"description": "Whether the class or mixin is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the class.",
"type": "string"
},
"events": {
"description": "The events that this element fires.",
"items": {
"$ref": "#/definitions/Event"
},
"type": "array"
},
"kind": {
"enum": [
"mixin"
],
"type": "string"
},
"members": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/ClassField"
},
{
"$ref": "#/definitions/ClassMethod"
}
]
},
"type": "array"
},
"mixins": {
"description": "Any class mixins applied in the extends clause of this class.\n\nIf mixins are applied in the class definition, then the true superclass\nof this class is the result of applying mixins in order to the superclass.\n\nMixins must be listed in order of their application to the superclass or\nprevious mixin application. This means that the innermost mixin is listed\nfirst. This may read backwards from the common order in JavaScript, but\nmatches the order of language used to describe mixin application, like\n\"S with A, B\".",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"name": {
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/definitions/Parameter"
},
"type": "array"
},
"return": {
"properties": {
"description": {
"description": "A markdown description.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"type": "object"
},
"slots": {
"description": "The shadow dom content slots that this element accepts.",
"items": {
"$ref": "#/definitions/Slot"
},
"type": "array"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"superclass": {
"$ref": "#/definitions/Reference",
"description": "The superclass of this class.\n\nIf this class is defined with mixin applications, the prototype chain\nincludes the mixin applications and the true superclass is computed\nfrom them."
},
"tagName": {
"description": "An optional tag name that should be specified if this is a\nself-registering element.\n\nSelf-registering elements must also include a CustomElementExport\nin the module's exports.",
"type": "string"
}
},
"required": [
"customElement",
"kind",
"name"
],
"type": "object"
},
"Demo": {
"properties": {
"description": {
"description": "A markdown description of the demo.",
"type": "string"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"url": {
"description": "Relative URL of the demo if it's published with the package. Absolute URL\nif it's hosted.",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"Event": {
"properties": {
"deprecated": {
"description": "Whether the event is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"inheritedFrom": {
"$ref": "#/definitions/Reference"
},
"name": {
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type",
"description": "The type of the event object that's fired."
}
},
"required": [
"name",
"type"
],
"type": "object"
},
"FunctionDeclaration": {
"properties": {
"deprecated": {
"description": "Whether the function is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"kind": {
"enum": [
"function"
],
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/definitions/Parameter"
},
"type": "array"
},
"return": {
"properties": {
"description": {
"description": "A markdown description.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"type": "object"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"JavaScriptExport": {
"properties": {
"declaration": {
"$ref": "#/definitions/Reference",
"description": "A reference to the exported declaration.\n\nIn the case of aggregating exports, the reference's `module` field must be\ndefined and the `name` field must be `\"*\"`."
},
"deprecated": {
"description": "Whether the export is deprecated. For example, the name of the export was changed.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"kind": {
"enum": [
"js"
],
"type": "string"
},
"name": {
"description": "The name of the exported symbol.\n\nJavaScript has a number of ways to export objects which determine the\ncorrect name to use.\n\n- Default exports must use the name \"default\".\n- Named exports use the name that is exported. If the export is renamed\n with the \"as\" clause, use the exported name.\n- Aggregating exports (`* from`) should use the name `*`",
"type": "string"
}
},
"required": [
"declaration",
"kind",
"name"
],
"type": "object"
},
"JavaScriptModule": {
"properties": {
"declarations": {
"description": "The declarations of a module.\n\nFor documentation purposes, all declarations that are reachable from\nexports should be described here. Ie, functions and objects that may be\nproperties of exported objects, or passed as arguments to functions.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/ClassDeclaration"
},
{
"$ref": "#/definitions/FunctionDeclaration"
},
{
"$ref": "#/definitions/MixinDeclaration"
},
{
"$ref": "#/definitions/VariableDeclaration"
},
{
"$ref": "#/definitions/CustomElementDeclaration"
},
{
"$ref": "#/definitions/CustomElementMixinDeclaration"
}
]
},
"type": "array"
},
"deprecated": {
"description": "Whether the module is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the module.",
"type": "string"
},
"exports": {
"description": "The exports of a module. This includes JavaScript exports and\ncustom element definitions.",
"items": {
"anyOf": [
{
"$ref": "#/definitions/JavaScriptExport"
},
{
"$ref": "#/definitions/CustomElementExport"
}
]
},
"type": "array"
},
"kind": {
"enum": [
"javascript-module"
],
"type": "string"
},
"path": {
"description": "Path to the javascript file needed to be imported.\n(not the path for example to a typescript file.)",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
}
},
"required": [
"kind",
"path"
],
"type": "object"
},
"MixinDeclaration": {
"description": "A description of a class mixin.\n\nMixins are functions which generate a new subclass of a given superclass.\nThis interfaces describes the class and custom element features that\nare added by the mixin. As such, it extends the CustomElement interface and\nClassLike interface.\n\nSince mixins are functions, it also extends the FunctionLike interface. This\nmeans a mixin is callable, and has parameters and a return type.\n\nThe return type is often hard or impossible to accurately describe in type\nsystems like TypeScript. It requires generics and an `extends` operator\nthat TypeScript lacks. Therefore it's recommended that the return type is\nleft empty. The most common form of a mixin function takes a single\nargument, so consumers of this interface should assume that the return type\nis the single argument subclassed by this declaration.\n\nA mixin should not have a superclass. If a mixins composes other mixins,\nthey should be listed in the `mixins` field.\n\nSee [this article]{@link https://justinfagnani.com/2015/12/21/real-mixins-with-javascript-classes/}\nfor more information on the classmixin pattern in JavaScript.",
"properties": {
"deprecated": {
"description": "Whether the class or mixin is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the class.",
"type": "string"
},
"kind": {
"enum": [
"mixin"
],
"type": "string"
},
"members": {
"items": {
"anyOf": [
{
"$ref": "#/definitions/ClassField"
},
{
"$ref": "#/definitions/ClassMethod"
}
]
},
"type": "array"
},
"mixins": {
"description": "Any class mixins applied in the extends clause of this class.\n\nIf mixins are applied in the class definition, then the true superclass\nof this class is the result of applying mixins in order to the superclass.\n\nMixins must be listed in order of their application to the superclass or\nprevious mixin application. This means that the innermost mixin is listed\nfirst. This may read backwards from the common order in JavaScript, but\nmatches the order of language used to describe mixin application, like\n\"S with A, B\".",
"items": {
"$ref": "#/definitions/Reference"
},
"type": "array"
},
"name": {
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/definitions/Parameter"
},
"type": "array"
},
"return": {
"properties": {
"description": {
"description": "A markdown description.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"type": "object"
},
"source": {
"$ref": "#/definitions/SourceReference"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"superclass": {
"$ref": "#/definitions/Reference",
"description": "The superclass of this class.\n\nIf this class is defined with mixin applications, the prototype chain\nincludes the mixin applications and the true superclass is computed\nfrom them."
}
},
"required": [
"kind",
"name"
],
"type": "object"
},
"Parameter": {
"properties": {
"default": {
"type": "string"
},
"deprecated": {
"description": "Whether the property is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description of the field.",
"type": "string"
},
"name": {
"type": "string"
},
"optional": {
"description": "Whether the parameter is optional. Undefined implies non-optional.",
"type": "boolean"
},
"readonly": {
"description": "Whether the property is read-only.",
"type": "boolean"
},
"rest": {
"description": "Whether the parameter is a rest parameter. Only the last parameter may be a rest parameter.\nUndefined implies single parameter.",
"type": "boolean"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
},
"type": {
"$ref": "#/definitions/Type"
}
},
"required": [
"name"
],
"type": "object"
},
"Privacy": {
"enum": [
"private",
"protected",
"public"
],
"type": "string"
},
"Reference": {
"description": "A reference to an export of a module.\n\nAll references are required to be publically accessible, so the canonical\nrepresentation of a reference is the export it's available from.\n\n`package` should generally refer to an npm package name. If `package` is\nundefined then the reference is local to this package. If `module` is\nundefined the reference is local to the containing module.\n\nReferences to global symbols like `Array`, `HTMLElement`, or `Event` should\nuse a `package` name of `\"global:\"`.",
"properties": {
"module": {
"type": "string"
},
"name": {
"type": "string"
},
"package": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Slot": {
"properties": {
"deprecated": {
"description": "Whether the slot is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
"type": [
"string",
"boolean"
]
},
"description": {
"description": "A markdown description.",
"type": "string"
},
"name": {
"description": "The slot name, or the empty string for an unnamed slot.",
"type": "string"
},
"summary": {
"description": "A markdown summary suitable for display in a listing.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"