doc: add null to fs.read position type - #65191
Closed
arhxam wants to merge 1 commit into
Closed
Conversation
The buffer/options overload gives position a default of null but omitted null from its type. The adjacent options-only overload includes it, and the implementation accepts it to read from the current file position. Make the type and default agree. Signed-off-by: Arham Wani <arhamwani765@gmail.com>
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
3 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.
Description
The
fs.read(fd, buffer[, options], callback)overload documentsoptions.positionas{integer|bigint}while also giving it a default ofnull. The adjacentfs.read(fd[, options], callback)overload correctlyincludes
nullin the accepted type, and the implementation usesnulltoread from the current file position.
This adds
nullto the documented type for the buffer/options overload so itstype and default agree. Documentation-only change.