docs: update deprecation notice of no-return-await
#18433
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
mdjermanovic
reviewed
May 8, 2024
docs/src/rules/no-return-await.md
Outdated
| @@ -7,7 +7,7 @@ further_reading: | |||
| - https://jakearchibald.com/2017/await-vs-return-vs-return-await/ | |||
| --- | |||
|
|
|||
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule no longer applies due to the fact JavaScript now handles native `Promises` differently. It can now be slower to remove `await` rather than keeping it. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). | |||
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule no longer applies due to the fact JavaScript now handles native `Promises` differently. The purpose of the rule was to discourage developers from using `return await` with async functions due to the perceived cost of the extra microtask. However, with advancements in JavaScript engine optimizations, particularly in modern engine like V8, the noted cost of the extra microtask no longer exists. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). | |||
There was a problem hiding this comment.
Suggested change
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule no longer applies due to the fact JavaScript now handles native `Promises` differently. The purpose of the rule was to discourage developers from using `return await` with async functions due to the perceived cost of the extra microtask. However, with advancements in JavaScript engine optimizations, particularly in modern engine like V8, the noted cost of the extra microtask no longer exists. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). | |
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule was to discourage the use of `return await`, to avoid an extra microtask. However, due to the fact that JavaScript now handles native `Promises` differently, there is no longer an extra microtask. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). |
I think the point is that there's no longer an extra microtask due to the change in JavaScript specification.
mdjermanovic
added
rule
fasttime
reviewed
May 8, 2024
docs/src/rules/no-return-await.md
Outdated
| @@ -7,7 +7,7 @@ further_reading: | |||
| - https://jakearchibald.com/2017/await-vs-return-vs-return-await/ | |||
| --- | |||
|
|
|||
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule no longer applies due to the fact JavaScript now handles native `Promises` differently. The purpose of the rule was to discourage developers from using `return await` with async functions due to the perceived cost of the extra microtask. However, with advancements in JavaScript engine optimizations, particularly in modern engine like V8, the noted cost of the extra microtask no longer exists. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). | |||
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule was to discourage the use of `return await`, to avoid an extra microtask. However, due to the fact that JavaScript now handles native `Promises` differently, there is no longer an extra microtask. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). | |||
There was a problem hiding this comment.
Suggested change
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule was to discourage the use of `return await`, to avoid an extra microtask. However, due to the fact that JavaScript now handles native `Promises` differently, there is no longer an extra microtask. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). | |
| This rule was **deprecated** in ESLint v8.46.0 with no replacement. The original intent of this rule was to discourage the use of `return await`, to avoid an extra microtask. However, due to the fact that JavaScript now handles native `Promise`s differently, there is no longer an extra microtask. More technical information can be found in [this V8 blog entry](https://v8.dev/blog/fast-async). |
mdjermanovic
approved these changes
May 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
update deprecation notice of
no-return-awaitrule.Is there anything you'd like reviewers to focus on?
Fixes: #18166