[add] Async Queue

[fix] building bugs
[optimize] update Upstream packages

Author: TechQuery

.gitignore

@@ -1,5 +1,5 @@
 node_modules/
 package-lock.json
 dist/
-.rts2_cache_*/
+.cache/
 docs/

.npmignore

@@ -1,5 +1,5 @@
 .editorconfig
 test/
-.rts2_cache_*/
+.cache/
 docs/
 .travis.yml

.travis.yml

@@ -13,10 +13,11 @@ install:
     - npm install
 script:
     - npm run ${SCRIPT}
+    - echo '' > docs/.nojekyll
 deploy:
     provider: pages
     on:
         branch: master
     skip_cleanup: true
     local_dir: ${FOLDER}
-    github_token: ${TOKEN}
+    token: ${TOKEN}

ReadMe.md

@@ -51,6 +51,29 @@ reader.readAsBlob(file);
 })();
 ```
 
+### Concurrent Task to Serial Queue
+
+```javascript
+import { createQueue } from 'iterable-observer';
+import Koa from 'koa';
+import BodyParser from 'koa-bodyparser';
+
+const { process, observable } = createQueue(),
+    app = new Koa();
+
+(async () => {
+    for await (const {
+        defer: { resolve },
+        data
+    } of observable)
+        resolve(JSON.stringify(data));
+})();
+
+app.use(BodyParser)
+    .use(async context => (context.body = await process(context.request.body)))
+    .listen(80);
+```
+
 [1]: https://github.com/tc39/proposal-observable
 [2]: https://tc39.es/ecma262/#sec-asyncgeneratorfunction-objects
 [3]: https://www.typescriptlang.org/

package.json

@@ -1,6 +1,6 @@
 {
     "name": "iterable-observer",
-    "version": "1.0.0-beta.0",
+    "version": "1.0.0-beta.3",
     "license": "LGPL-3.0",
     "author": "[email protected]",
     "description": "Observable Proposal implement based on Async Generator (ES 2018) & TypeScript",
@@ -23,45 +23,42 @@
     },
     "source": "source/index.ts",
     "types": "dist/index.d.ts",
-    "main": "dist/iterable-observer.umd.js",
-    "module": "dist/iterable-observer.js",
+    "main": "dist/index.js",
     "devDependencies": {
-        "@types/jest": "^24.0.23",
-        "husky": "^3.1.0",
-        "jest": "^24.9.0",
-        "lint-staged": "^9.4.3",
-        "microbundle": "^0.11.0",
-        "open-cli": "^5.0.0",
-        "prettier": "^1.19.1",
-        "ts-jest": "^24.2.0",
-        "typedoc": "^0.15.3",
-        "typescript": "^3.7.2"
+        "@types/jest": "^25.2.1",
+        "@types/node": "^13.11.1",
+        "husky": "^4.2.5",
+        "jest": "^25.3.0",
+        "lint-staged": "^10.1.3",
+        "open-cli": "^6.0.1",
+        "parcel-bundler": "^1.12.4",
+        "prettier": "^2.0.4",
+        "ts-jest": "^25.3.1",
+        "typedoc": "^0.17.4",
+        "typescript": "^3.8.3"
     },
     "prettier": {
         "singleQuote": true,
+        "trailingComma": "none",
+        "arrowParens": "avoid",
         "tabWidth": 4
     },
     "lint-staged": {
         "*.{md,json,ts}": [
-            "prettier --write",
-            "git add"
+            "prettier --write"
         ]
     },
     "jest": {
         "preset": "ts-jest",
-        "testEnvironment": "node",
-        "testRegex": "/test/.*\\.(test|spec)?\\.ts$",
-        "moduleFileExtensions": [
-            "js",
-            "ts",
-            "json"
-        ]
+        "testTimeout": 8000
     },
     "scripts": {
-        "test": "lint-staged && jest",
+        "test": "lint-staged  &&  jest --no-cache",
         "debug": "node --inspect node_modules/jest/bin/jest --runInBand",
+        "pack-type": "tsc  &&  rm -f dist/*.{js,map}",
+        "pack-dist": "parcel build source/index.ts --global IterableObserver",
         "pack-docs": "typedoc --name \"Iterable Observer\" --out docs/ source/",
-        "build": "rm -rf dist/  &&  microbundle  &&  npm run pack-docs",
+        "build": "rm -rf dist/  &&  npm run pack-type  &&  npm run pack-dist  &&  npm run pack-docs",
         "help": "npm run pack-docs  &&  open-cli docs/index.html",
         "prepublishOnly": "npm test  &&  npm run build"
     },

source/Observable.ts

@@ -1,4 +1,6 @@
-import { Defer, makeDefer } from './utility';
+import { Defer, makeDefer, EventTrigger } from './utility';
+
+Symbol.observable = Symbol('observable');
 
 export interface Observer<T = any> {
     next(value: T): void;
@@ -20,21 +22,14 @@ export interface Subscribable<T = any> {
     ): Subscription;
 }
 
-export type SubscriberFunction = (observer: Observer) => (() => void) | void;
-
-export type EventHandler = (data: any) => void;
-
-export interface EventTrigger {
-    addEventListener?(name: string, handler: EventHandler): void;
-    removeEventListener?(name: string, handler: EventHandler): void;
-    on?(name: string, handler: EventHandler): this;
-    off?(name: string, handler: EventHandler): this;
-}
+export type SubscriberFunction<T = any> = (
+    observer: Observer<T>
+) => (() => void) | void;
 
 export class Observable<T = any> implements Subscribable {
-    private subscriber: SubscriberFunction;
+    private subscriber: SubscriberFunction<T>;
 
-    constructor(subscriber: SubscriberFunction) {
+    constructor(subscriber: SubscriberFunction<T>) {
         this.subscriber = subscriber;
     }
 
@@ -74,7 +69,7 @@ export class Observable<T = any> implements Subscribable {
             yield queue[0].promise;
 
             queue.shift();
-        } while (queue[0] || !done);
+        } while (queue[0]);
     }
 
     static of<T = any>(...items: T[]) {

source/Queue.ts

@@ -0,0 +1,31 @@
+import { Observer, Observable } from './Observable';
+import { makeDefer, Defer } from './utility';
+
+export function createQueue<D = any>() {
+    type Data = { defer: Defer; data: D };
+
+    var feedNext: Observer<Data>['next'], stop: Observer<Data>['complete'];
+
+    const observable = new Observable<Data>(({ next, complete }) => {
+        (feedNext = next), (stop = complete);
+    });
+
+    return {
+        process<R = any>(data: D) {
+            const defer = makeDefer<R>();
+
+            if (!feedNext)
+                throw Error("Can't process data before Queue consuming");
+
+            feedNext({ defer, data });
+
+            return defer.promise;
+        },
+        destroy() {
+            if (!stop) throw Error("Can't stop a Queue before Queue consuming");
+
+            stop();
+        },
+        observable
+    };
+}

source/global.d.ts

@@ -0,0 +1,3 @@
+interface SymbolConstructor {
+    observable: symbol;
+}

source/index.ts

@@ -1,2 +1,3 @@
 export * from './utility';
 export * from './Observable';
+export * from './Queue';

source/utility.ts

@@ -13,3 +13,12 @@ export function makeDefer<T>(): Defer<T> {
 
     return { resolve, reject, promise };
 }
+
+export type EventHandler = (data: any) => void;
+
+export interface EventTrigger {
+    addEventListener?(name: string, handler: EventHandler): void;
+    removeEventListener?(name: string, handler: EventHandler): void;
+    on?(name: string, handler: EventHandler): this;
+    off?(name: string, handler: EventHandler): this;
+}