release v5.0.0

JS-DevTools · Nov 4, 2019 · 5bffd88 · 5bffd88
1 parent 6a27455
commit 5bffd88
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,23 @@ All notable changes will be documented in this file.
 `readdir-enhanced` adheres to [Semantic Versioning](http://semver.org/).
 
 
+[v5.0.0](https://github.com/JS-DevTools/readdir-enhanced/tree/v5.0.0) (2019-11-03)
+----------------------------------------------------------------------------------------------------
+
+#### Breaking Changes
+
+- Previously there were alternative versions of each function that returned [`fs.Stats` objects](https://nodejs.org/api/fs.html#fs_class_fs_stats) rather than path strings.  These functions have been replaced by [the `stats` option](README.md#stats).
+
+#### Other Changes
+
+- Completely rewritten in TypeScript
+
+- Added an [async iterable interface](README.md#pick-your-api) so you can now crawl directories using convenient [`for await...of` syntax](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of). This is faster and more efficient that the normal sync or async interfaces, since it doesn't require buffering all results in memory.
+
+
+[Full Changelog](https://github.com/JS-DevTools/readdir-enhanced/compare/v4.0.3...v5.0.0)
+
+
 [v4.0.0](https://github.com/JS-DevTools/readdir-enhanced/tree/v4.0.0) (2019-08-19)
 ----------------------------------------------------------------------------------------------------
 #### Breaking Changes

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "readdir-enhanced",
-  "version": "5.0.0-beta.1",
+  "version": "5.0.0",
   "description": "fs.readdir with sync, async, and streaming APIs + filtering, recursion, absolute paths, etc.",
   "keywords": [
     "fs",