fs: runtime deprecate mistakenly exposed fs.Dir methods
#58679
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `processReadResult` and `readSyncRecursive` methods on the `fs.Dir` class were mistakenly exposed as public APIs. These methods are intended only for internal use. They are now runtime deprecated and will be removed.
jasnell
added
fs
|
Alternative to #58672 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #58679 +/- ##
==========================================
- Coverage 90.15% 90.14% -0.01%
==========================================
Files 636 636
Lines 188061 188078 +17
Branches 36899 36903 +4
==========================================
+ Hits 169537 169552 +15
- Misses 11278 11280 +2
Partials 7246 7246
🚀 New features to boost your workflow:
|
LiviaMedeiros
approved these changes
Jun 11, 2025
|
|
||
| ### DEP0198: `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` | ||
|
|
||
| <!-- |
There was a problem hiding this comment.
Suggested change
| <!-- | |
| <!-- YAML |
| <!-- | ||
| changes: | ||
| - version: REPLACEME | ||
| pr-url: https://github.com/nodejs/node/pull/00000 |
There was a problem hiding this comment.
Suggested change
| pr-url: https://github.com/nodejs/node/pull/00000 | |
| pr-url: https://github.com/nodejs/node/pull/58679 |
|
|
||
| Type: Runtime | ||
|
|
||
| The `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` |
There was a problem hiding this comment.
Suggested change
| The `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` | |
| The `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult()` |
or
Suggested change
| The `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` | |
| The `fs.Dir.prototype.readSyncRecursive` and `fs.Dir.prototype.processReadResult` |
|
|
||
| The [`util.types.isNativeError`][] API is deprecated. Please use [`Error.isError`][] instead. | ||
|
|
||
| ### DEP0198: `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` |
There was a problem hiding this comment.
Suggested change
| ### DEP0198: `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` | |
| ### DEP0198: `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult()` |
or
Suggested change
| ### DEP0198: `fs.Dir.prototype.readSyncRecursive()` and `fs.Dir.prototype.processReadResult` | |
| ### DEP0198: `fs.Dir.prototype.readSyncRecursive` and `fs.Dir.prototype.processReadResult` |
anonrig
approved these changes
Jun 11, 2025
|
If it's undocumented and we find no use in the ecosystem, I don't think we need a deprecation, we can directly remove it in a semver-major IMO |
|
Let's get some other opinions from @nodejs/tsc on it... if there are no objections to handling it without a deprecation then ok |
jasnell
added
the
tsc-agenda
|
I'm ok with landing without a deprecation, and just removing/hiding it. |
I concur. Landing #58672 as
semver-major
|
|
Closing in favor of #58672 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
processReadResultandreadSyncRecursivemethods on thefs.Dirclass were mistakenly exposed as public APIs. These methods are intended only for internal use. They are now runtime deprecated and will be removed.There is an extremely slim possibility that this change could be breaking in that if someone out there happened to be monkeypatching these then the approach taken in this PR would break that. A github code search revealed no such cases and I believe it's unlikely enough that we shouldn't need to worry about it.