Skip to content

Commit

Permalink
docs(node-builtins): Specify that only static properties are supported (
Browse files Browse the repository at this point in the history
#272)

* docs(node-builtins): Specify that only static properties are supported

* docs(no-deprecated-api): Specify that only static properties are supported
  • Loading branch information
scagood authored May 10, 2024
1 parent a99acb7 commit 735a520
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/rules/no-deprecated-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
Node has many deprecated API.
The community is going to remove those API from Node in future, so we should not use those.

This only supports the static apis, eg `Buffer.from` is supported, but `Buffer#includes` is not.

## 📖 Rule Details

Examples of 👎 **incorrect** code for this rule:
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-unsupported-features/node-builtins.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ You can check [Node.js Documentation](https://nodejs.org/api/) to know which Nod
This rule reports unsupported Node.js built-in APIs on the configured Node.js version as lint errors.
Editor integrations of ESLint would be useful to know it in real-time.

This only supports the static apis, eg `Buffer.from` is supported, but `Buffer#includes` is not.

## 📖 Rule Details

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/).
Expand Down

0 comments on commit 735a520

Please sign in to comment.