All notable changes will be documented in this file. Readdir Enhanced adheres to Semantic Versioning.
v6.0.0 (2020-02-17)
-
Moved Readdir Enhanced to the @JSDevTools scope on NPM
-
The "readdir-enhanced" NPM package is now just a wrapper around the scoped "@jsdevtools/readdir-enhanced" package
v5.1.0 (2019-11-07)
- The
filteroption can now be set to a boolean to include/exclude everything.
v5.0.0 (2019-11-03)
- Previously there were alternative versions of each function that returned
fs.Statsobjects rather than path strings. These functions have been replaced by thestatsoption.
-
Completely rewritten in TypeScript
-
Added an async iterable interface so you can now crawl directories using convenient
for await...ofsyntax. This is faster and more efficient that the normal sync or async interfaces, since it doesn't require buffering all results in memory.
v4.0.0 (2019-08-19)
- Removed code that was stripping the drive letters from Windows paths when using glob filters.
v3.0.0 (2019-06-13)
-
Dropped support for Node 6
-
Updated all code to ES6+ syntax (async/await, template literals, arrow functions, etc.)
- Added TypeScript definitions
v2.2.0 (2018-01-09)
-
Refactored the codebase to use ES6 syntax (Node v4.x compatible)
-
You can now provide your own implementation for the filesystem module that's used by
readdir-enhanced. Just set thefsoption to your implementation. Thanks to @mrmlnc for the idea and the PR! -
Better error handling, especially around user-specified logic, such as
options.deep,options.filter, andoptions.fs
v2.1.0 (2017-12-01)
- The
fs.Statsobjects now include adepthproperty, which indicates the number of subdirectories beneath the base path. Thanks to @mrmlnc for the PR!
v2.0.0 (2017-11-15)
- Dropped support for Node v0.x, which is no longer actively maintained. Please upgrade to Node 4 or newer.
v1.5.0 (2017-04-10)
The deep option can now be set to a regular expression, a glob pattern, or a function, which allows you to customize which subdirectories get crawled. Of course, you can also still still set the deep option to true to crawl all subdirectories, or a number if you just want to limit the recursion depth.
v1.4.0 (2016-08-26)
The filter option can now be set to a regular expression or a glob pattern string, which simplifies filtering based on file names. Of course, you can still set the filter option to a function if you need to perform more advanced filtering based on the fs.Stats of each file.
v1.3.4 (2016-08-26)
As of this release, readdir-enhanced is fully tested on all major Node versions (0.x, 4.x, 5.x, 6.x) on linux and Windows, with nearly 100% code coverage. I do all of my local development and testing on MacOS, so that's covered too.