Skip to content

Commit 11a865d

Browse files
committed
Add deprecated to FunctionLike
Also clean up a redundant `deprecated` that resulted from a bad rebase.
1 parent f893b20 commit 11a865d

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

schema.d.ts

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -257,14 +257,6 @@ export interface CustomElement extends ClassLike {
257257
* custom element class
258258
*/
259259
customElement: true;
260-
261-
// members?: Array<CustomElementMember>;
262-
263-
/**
264-
* Whether the custom element is deprecated.
265-
* If the value is a string, it's the reason for the deprecation.
266-
*/
267-
deprecated?: boolean | string;
268260
}
269261

270262
export interface Attribute {
@@ -695,6 +687,12 @@ export interface FunctionLike {
695687
*/
696688
description?: string;
697689

690+
/**
691+
* Whether the function is deprecated.
692+
* If the value is a string, it's the reason for the deprecation.
693+
*/
694+
deprecated?: boolean | string;
695+
698696
parameters?: Parameter[];
699697

700698
return?: {

schema.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,13 @@
155155
},
156156
"ClassMethod": {
157157
"properties": {
158+
"deprecated": {
159+
"description": "Whether the function is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
160+
"type": [
161+
"string",
162+
"boolean"
163+
]
164+
},
158165
"description": {
159166
"description": "A markdown description.",
160167
"type": "string"
@@ -597,6 +604,13 @@
597604
},
598605
"FunctionDeclaration": {
599606
"properties": {
607+
"deprecated": {
608+
"description": "Whether the function is deprecated.\nIf the value is a string, it's the reason for the deprecation.",
609+
"type": [
610+
"string",
611+
"boolean"
612+
]
613+
},
600614
"description": {
601615
"description": "A markdown description.",
602616
"type": "string"
@@ -732,6 +746,7 @@
732746
"type": "string"
733747
},
734748
"path": {
749+
"description": "Path to the javascript file needed to be imported. \n(not the path for example to a typescript file.)",
735750
"type": "string"
736751
},
737752
"summary": {

0 commit comments

Comments
 (0)