Skip to content

Commit 735a520

Browse files
authoredMay 10, 2024··
docs(node-builtins): Specify that only static properties are supported (#272)
* docs(node-builtins): Specify that only static properties are supported * docs(no-deprecated-api): Specify that only static properties are supported
1 parent a99acb7 commit 735a520

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed
 

‎docs/rules/no-deprecated-api.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
Node has many deprecated API.
88
The community is going to remove those API from Node in future, so we should not use those.
99

10+
This only supports the static apis, eg `Buffer.from` is supported, but `Buffer#includes` is not.
11+
1012
## 📖 Rule Details
1113

1214
Examples of 👎 **incorrect** code for this rule:

‎docs/rules/no-unsupported-features/node-builtins.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ You can check [Node.js Documentation](https://nodejs.org/api/) to know which Nod
1010
This rule reports unsupported Node.js built-in APIs on the configured Node.js version as lint errors.
1111
Editor integrations of ESLint would be useful to know it in real-time.
1212

13+
This only supports the static apis, eg `Buffer.from` is supported, but `Buffer#includes` is not.
14+
1315
## 📖 Rule Details
1416

1517
This rule reports APIs of Node.js built-in APIs on the basis of [Node.js v13.2.0 Documentation](https://nodejs.org/docs/v13.2.0/api/).

0 commit comments

Comments
 (0)
Please sign in to comment.