recursive-readdir-async - npm Package Compare versions

Comparing version 1.1.7 to 1.1.8

package.json

 {
   "name": "recursive-readdir-async",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Module to recursive read directory async (non blocking). Must be used with Promises. Configurable, extended filtering. etc.",
-  "main": "module.js",
+  "main": "build/module.cjs.js",
+  "module": "build/module.esm.js",
   "scripts": {
@@ -11,2 +12,3 @@ "test": "nyc mocha",
     "build": "uglifyjs --compress --mangle reserved=[file,path,options,progress] --comments -- module.js > module.min.js && jsdoc module.js -d ./docs -R ./README.md",
+    "release": "rollup -c",
     "lint": "eslint ."
@@ -43,2 +45,3 @@ },
   "devDependencies": {
+    "@rollup/plugin-node-resolve": "^8.4.0",
     "coveralls": "^3.1.0",
@@ -55,4 +58,5 @@ "eslint": "^5.16.0",
     "nyc": "^14.1.1",
+    "rollup": "^2.22.1",
     "uglify-es": "^3.3.10"
   }
 }

README.md

@@ -8,5 +8,6 @@ [![Build Status](https://travis-ci.org/m0rtadelo/recursive-readdir-async.svg?branch=master)](https://travis-ci.org/m0rtadelo/recursive-readdir-async)
 # recursive-readdir-async
-NPM Module to recursive read directory async (non blocking). Returns Promise. Configurable, with callback for extended filtering and progress status. Quiet, NO dependencies.
-As non blocking module it is perfect to be used in any javascript based Desktop applications.
+NPM Module to recursive read directory async (non blocking). Returns Promise. Configurable, with callback for extended filtering and progress status. Quiet, NO dependencies. As non blocking module it is perfect to be used in any javascript based Desktop applications.
 >This module uses Promises and can't be used in old javascript engines.
+
+>Compatible with CommonJS (require key) and ES6 (import key).
 ## Installation
@@ -17,3 +18,3 @@ For normal usage into a project, you must install as a NPM dependency. The next command will do all the work:
 ```
-After install, you can use the module using the *require* key:
+After install, you can use the module using the *require* key (CommonJS):
 ```javascript
@@ -24,6 +25,11 @@ // Assign recursive-readdir-async to constant
 ```
+or using the *import* key (ES6):
+```typescript
+// Import ES6 module
+import * as rra from 'recursive-readdir-async'
+// use it
+```
 ## Usage
 Example of basic usage:
 ```javascript
-const rra = require('recursive-readdir-async');
 const list = await rra.list('.');
@@ -33,3 +39,2 @@ console.log(list)
 ```javascript
-const rra = require('recursive-readdir-async');
 rra.list('.').then(function(list){
@@ -41,3 +46,2 @@ console.log(list)
 ```javascript
-const rra = require('recursive-readdir-async');
 const options = {
@@ -44,0 +48,0 @@ mode: rra.LIST,

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

104356

increased by267.71%

Number of package files

10

increased by100%

Lines of code

816

increased by101.48%

Number of lines in readme file

219

increased by1.86%

Worsened metrics

Dev dependency count

14

increased by16.67%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes