Implement Node.js-compatible Dir API with proper error handling and state management #1115
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.
This PR implements a complete Node.js-compatible
Dir
API for memfs, addressing all the requirements outlined in the issue. The implementation now matches Node.jsfs.Dir
behavior exactly, including proper error handling, state management, and concurrent operation detection.Key Changes
1. Removed Helper Functions
wrapAsync
,isFunction
, andpromisify
helper methods2. Enhanced State Management
closed
property to track directory handle stateoperationQueue
for managing concurrent async operations3. Comprehensive Error Handling
ERR_DIR_CLOSED
error code for operations on closed directoriesERR_DIR_CONCURRENT_OPERATION
error code for sync operations during async operationsprocess.nextTick()
for callbacks4. Fixed Path Property
getParentPath()
togetPath()
to return the correct directory path5. Improved Method Implementations
Close Operations:
Error Handling Examples:
Concurrent Operation Detection:
6. Refactored Async Iterator
read()
methodfor await
loopsTesting
Added comprehensive test suite covering:
All existing tests continue to pass, ensuring no regressions were introduced.
Compatibility
The implementation now matches Node.js
fs.Dir
behavior exactly:Fixes #1087.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.