Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add deprecated to FunctionLike #105

Merged
merged 1 commit into from
Sep 12, 2022
Merged

Add deprecated to FunctionLike #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions schema.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,14 +257,6 @@ export interface CustomElement extends ClassLike {
* custom element class
*/
customElement: true;

// members?: Array<CustomElementMember>;

/**
* Whether the custom element is deprecated.
* If the value is a string, it's the reason for the deprecation.
*/
deprecated?: boolean | string;
}

export interface Attribute {
Expand Down Expand Up @@ -695,6 +687,12 @@ export interface FunctionLike {
*/
description?: string;

/**
* Whether the function is deprecated.
* If the value is a string, it's the reason for the deprecation.
*/
deprecated?: boolean | string;

parameters?: Parameter[];

return?: {
Expand Down
15 changes: 15 additions & 0 deletions schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,13 @@
},
"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"
Expand Down Expand Up @@ -597,6 +604,13 @@
},
"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"
Expand Down Expand Up @@ -732,6 +746,7 @@
"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": {
Expand Down