Skip to content

Commit ebbd111

Browse files
committed
doc: add deprecation notice to dirent.path
Refs: nodejs#51020
1 parent 1e31a01 commit ebbd111

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api/fs.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6642,7 +6642,7 @@ value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
66426642
66436643
<!-- YAML
66446644
added:
6645-
- v21.4.0
6645+
- REPLACEME
66466646
-->
66476647
66486648
> Stability: 1 – Experimental
@@ -6657,8 +6657,11 @@ The path to the parent directory of the file this {fs.Dirent} object refers to.
66576657
added:
66586658
- v20.1.0
66596659
- v18.17.0
6660+
deprecated: REPLACEME
66606661
-->
66616662
6663+
> Stability: 0 - Deprecated: Use [`dirent.parentPath`][] instead.
6664+
66626665
* {string}
66636666
66646667
Alias for `dirent.parentPath`.
@@ -8214,6 +8217,7 @@ the file contents.
82148217
[`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER
82158218
[`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw
82168219
[`UV_THREADPOOL_SIZE`]: cli.md#uv_threadpool_sizesize
8220+
[`dirent.parentPath`]: #direntparentpath
82178221
[`event ports`]: https://illumos.org/man/port_create
82188222
[`filehandle.createReadStream()`]: #filehandlecreatereadstreamoptions
82198223
[`filehandle.createWriteStream()`]: #filehandlecreatewritestreamoptions

0 commit comments

Comments
 (0)