From 4ca8f337816c917bb6e6dc8948cce8752c3b4a00 Mon Sep 17 00:00:00 2001 From: Darshan Sen Date: Fri, 2 Apr 2021 19:24:51 +0530 Subject: [PATCH] fs,doc: doc-only deprecate nullish position in read and readSync Refs: https://github.com/nodejs/node/pull/37101 --- doc/api/deprecations.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 5d2127063d96b8..0f76c7769e99f2 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -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` + + +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