From 194ff6a40f9a9655c6403e1d7d7048490d78fc77 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Tue, 5 Dec 2023 22:15:23 +0100 Subject: [PATCH] doc: add deprecation notice to `dirent.path` Refs: https://github.com/nodejs/node/pull/51020 PR-URL: https://github.com/nodejs/node/pull/51059 Backport-PR-URL: https://github.com/nodejs/node/pull/51021 Reviewed-By: Debadree Chatterjee Reviewed-By: Luigi Pinca Reviewed-By: Moshe Atlow PR-URL: https://github.com/nodejs/node/pull/50976 --- doc/api/fs.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/fs.md b/doc/api/fs.md index d6ac052b3c9f04..6c5944878e0ebf 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -6454,8 +6454,11 @@ The path to the parent directory of the file this {fs.Dirent} object refers to. +> Stability: 0 - Deprecated: Use [`dirent.parentPath`][] instead. + * {string} The base path that this {fs.Dirent} object refers to. @@ -7995,6 +7998,7 @@ the file contents. [`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER [`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw [`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize +[`dirent.parentPath`]: #direntparentpath [`event ports`]: https://illumos.org/man/port_create [`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions [`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions