Skip to content

fs,doc: doc-only deprecate nullish position in read and readSync #38043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
RaisinTen wants to merge 1 commit into from
Closed

fs,doc: doc-only deprecate nullish position in read and readSync #38043

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2781,6 +2781,19 @@ These properties are now available within the standard `detail` property
of the `PerformanceEntry` object. The existing accessors have been
deprecated and should no longer be used.

### DEP0XXX: Nullish `position` in `fs.read` and `fs.readSync`
<!-- YAML
added: REPLACEME
-->

Type: Documentation-only

Previously in `fs.read` and `fs.readSync`, any nullish value for `position` was
replaced with `-1` internally. This is being deprecated and the default value
of `position` in these functions are being changed from `null` to `-1`, thus
conforming to the mentioned accepted data type in the documentation, `integer`
or `bigint`.

[Legacy URL API]: url.md#url_legacy_url_api
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
Expand Down