doc: clarify stream construct promise handling#63349
Closed
MukundaKatta wants to merge 1 commit into
Closed
Conversation
Author
|
Pulling this back. Sorry for the rate. |
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.
Refs: #39992
Documents that stream
_construct()implementations may either call the callback or return a promise, and that doing both is invalid. The clarification is added to both writable and readable_construct()docs because they share the same construct behavior.Validation:
node tools/lint-md/lint-md.mjs doc/api/stream.mdgit diff --checkReadableconstruct delays_read()until fulfillment