Skip to content

Commit

Permalink
doc: deprecate dirent.path
Browse files Browse the repository at this point in the history
PR-URL: #51020
Backport-PR-URL: #51021
Reviewed-By: Yagiz Nizipli <yagiz.nizipli@sentry.io>
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Moshe Atlow <moshe@atlow.co.il>
PR-URL: #50976
  • Loading branch information
aduh95 authored and richardlau committed Mar 18, 2024
1 parent 26e8f77 commit 0f09267
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions doc/api/deprecations.md
Expand Up @@ -3321,6 +3321,32 @@ In a future version of Node.js, [`message.headers`][],
[`message.headersDistinct`][], [`message.trailers`][], and
[`message.trailersDistinct`][] will be read-only.

<!-- md-lint skip-deprecation DEP0172 -->

<!-- md-lint skip-deprecation DEP0173 -->

<!-- md-lint skip-deprecation DEP0174 -->

<!-- md-lint skip-deprecation DEP0175 -->

<!-- md-lint skip-deprecation DEP0176 -->

<!-- md-lint skip-deprecation DEP0177 -->

### DEP0178: `dirent.path`

<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/51020
description: Documentation-only deprecation.
-->

Type: Documentation-only

The [`dirent.path`][] is deprecated due to its lack of consistency across
release lines. Please use [`dirent.parentPath`][] instead.

[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
[RFC 8247 Section 2.4]: https://www.rfc-editor.org/rfc/rfc8247#section-2.4
Expand Down Expand Up @@ -3366,6 +3392,8 @@ In a future version of Node.js, [`message.headers`][],
[`decipher.setAuthTag()`]: crypto.md#deciphersetauthtagbuffer-encoding
[`diagnostics_channel.subscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelsubscribename-onmessage
[`diagnostics_channel.unsubscribe(name, onMessage)`]: diagnostics_channel.md#diagnostics_channelunsubscribename-onmessage
[`dirent.parentPath`]: fs.md#direntparentpath
[`dirent.path`]: fs.md#direntpath
[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback
[`dnsPromises.lookup()`]: dns.md#dnspromiseslookuphostname-options
[`domain`]: domain.md
Expand Down

0 comments on commit 0f09267

Please sign in to comment.