async-iterable-stream - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

index.js

 class AsyncIterableStream {
-  constructor(generatorFactory) {
-    this.generatorFactory = generatorFactory;
+  constructor(asyncIteratorFactory) {
+    this._asyncIteratorFactory = asyncIteratorFactory;
   }
 
   next() {
-    return this.generatorFactory().next();
+    return this._asyncIteratorFactory().next();
   }
@@ -15,3 +15,3 @@
   [Symbol.asyncIterator]() {
-    return this.generatorFactory();
+    return this._asyncIteratorFactory();
   }
@@ -18,0 +18,0 @@ }

package.json

 {
   "name": "async-iterable-stream",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "A readable async stream which can be iterated over using a for-await-of loop.",
   "main": "index.js",
+  "scripts": {
+    "test": "./node_modules/mocha/bin/_mocha --reporter spec --timeout 10000 --slow 10000"
+  },
   "repository": {
@@ -7,0 +10,0 @@ "type": "git",

README.md

 # async-iterable-stream
 A readable stream which can be iterated over using a for-await-of loop.
+
+The constructor accepts an `asyncIteratorFactory` as argument; this can be either an async generator function or a regular function which returns an async iterator.
+In the case of a generator function, the `asyncIteratorFactory` should yield a sequence of `Promise` objects which resolve one at a time in the same order as they appear in the sequence.
+
+## Installation
+
+```
+npm install async-iterable-stream
+```

No alert changes

Improved metrics

Total package byte prevSize

5245

increased by140.49%

Number of package files

5

increased by25%

Lines of code

96

increased by540%

Number of lines in readme file

12

increased by300%

No dependency changes