docs: Add caution about suppressing errors#174
Merged
Conversation
The TSDoc comment for `createDeferredPromise` has been updated to include a caution about using the `suppressUnhandledRejection` option. The comment now explains in more detail why this option is useful, and why it can be dangerous and should be treated with caution.
Mrtenz
approved these changes
Mar 13, 2024
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.
The TSDoc comment for
createDeferredPromisehas been updated to include a caution about using thesuppressUnhandledRejectionoption. The comment now explains in more detail why this option is useful, and why it can be dangerous and should be treated with caution.