doc: add deprecation notice to dirent.path

Refs: #51020 PR-URL: #51059 Reviewed-By: Debadree Chatterjee <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Moshe Atlow <[email protected]>
nodejs · Dec 15, 2023 · c45a9a3 · c45a9a3
1 parent c2b6edf
commit c45a9a3
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -6633,8 +6633,11 @@ The path to the parent directory of the file this {fs.Dirent} object refers to.
 added:
   - v20.1.0
   - v18.17.0
+deprecated: REPLACEME
 -->
 
+> Stability: 0 - Deprecated: Use [`dirent.parentPath`][] instead.
+
 * {string}
 
 Alias for `dirent.parentPath`.
@@ -8190,6 +8193,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