Skip to content

Commit

Permalink
doc: add deprecation notice to dirent.path
Browse files Browse the repository at this point in the history
  • Loading branch information
aduh95 committed Dec 5, 2023
1 parent 1e31a01 commit ebbd111
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6642,7 +6642,7 @@ value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
<!-- YAML
added:
- v21.4.0
- REPLACEME
-->
> Stability: 1 – Experimental
Expand All @@ -6657,8 +6657,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`.
Expand Down Expand Up @@ -8214,6 +8217,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
Expand Down

0 comments on commit ebbd111

Please sign in to comment.