@jnode/request 2.0.0-beta.0 → 2.0.0-beta.1-doc

package/README.md

@@ -150,3 +150,16 @@ The response stream or any readable stream.
 - Type: [\<readline.Interface\>](https://nodejs.org/docs/latest/api/readline.html#class-readlineinterface)
 
 An interface for reading data from response one line at a time.
+
+### `eventReceiver[Symbol.asyncIterator]()`
+
+- Returns: [\<AsyncIterator\>](https://tc39.github.io/ecma262/#sec-asynciterator-interface)
+
+Create an AsyncIterator object that iterates through each event as an object. This method allows asynchronous iteration of InterfaceConstructor objects through for await...of loops.
+
+```js
+for await (const event of eventReceiver) {
+    // Each event in the event stream will be successively available here as
+    // { data, event, id }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jnode/request",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.1-doc",
   "description": "Simple HTTP(s) requesting package for Node.js.",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -196,6 +196,59 @@ class EventReceiver extends EventEmitter {
 		});
 
 		this.rl.on('close', () => { this.emit('close'); });
+		this.rl.on('error', (err) => {
+			this.emit('error', err);
+			this.emit('close');
+		});
+	}
+
+	// async generator support
+	[Symbol.asyncIterator]() {
+		let queue = [];
+		let done = false;
+		let resolvers = [];
+
+		// event
+		const onEvent = (event) => {
+			if (resolvers.length > 0) {
+				resolvers.shift()({ value: event, done: false });
+			} else {
+				queue.push(event);
+			}
+		};
+		this.on('event', onEvent);
+
+		// close (including error)
+		const onClose = () => {
+			done = true;
+			while (resolvers.length > 0) {
+				resolvers.shift()({ done: true });
+			}
+		};
+		this.on('close', onClose);
+
+		return {
+			next: () => {
+				return new Promise((resolve, reject) => {
+					if (queue.length > 0) {
+						resolve({ value: queue.shift(), done: false });
+					} else if (done) {
+						resolve({ done: true });
+					} else {
+						resolvers.push(resolve);
+					}
+				});
+			},
+			return: () => {
+				done = true;
+				while (resolvers.length > 0) {
+					resolvers.shift()({ done: true });
+				}
+				this.off('event', onEvent);
+				this.off('close', onClose);
+			},
+			[Symbol.asyncIterator]() { return this; }
+		}
 	}
 }