doc: add deprecation notice to dirent.path

Refs: #51020 PR-URL: #51059 Backport-PR-URL: #51021 Reviewed-By: Debadree Chatterjee <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Moshe Atlow <[email protected]> PR-URL: #50976
nodejs · Mar 18, 2024 · 194ff6a · 194ff6a
1 parent 0f09267
commit 194ff6a
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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.
 
 <!-- YAML
 added: v18.17.0
+deprecated: REPLACEME
 -->
 
+> 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