Update Promise.race documentation regarding error handling#44286
Open
mb-realpage wants to merge 1 commit into
Open
Update Promise.race documentation regarding error handling#44286mb-realpage wants to merge 1 commit into
mb-realpage wants to merge 1 commit into
Conversation
Clarified that capturing and clearing the timeout handle is not required when using `Promise.race` to time out a request. Provided an example to illustrate this point.
github-actions
Bot
added
Content:JS
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Clarified that capturing and clearing the timeout handle is not required when using
Promise.raceto time out a request. Provided an example to illustrate this point.Description
Expanded the description of "Using Promise.race() to implement request timeout" to demonstrate how the timeout does not need to be captured to prevent the throwing of the error: every iterable item passed to
Promise.racethat loses the race is consumed silently, so the error is thrown but does not become anunhandledRejection.Motivation
I refactored a significant chunk of code to use
Promise.raceand an auto-throwing method, then worried that the timeouts might be generating unhandled rejections; after checking the MDN, I didn't see any reference to this specific case. So I developed a "solution" that promptly created the problem I was trying to avoid.Additional details
None.
Related issues and pull requests
None.