@guanghechen/observable 5.0.4 → 6.0.1

package/CHANGELOG.md

@@ -1,80 +1,11 @@
 # Change Log
 
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [5.0.4](https://github.com/guanghechen/node-scaffolds/compare/@guanghechen/observable@5.0.3...@guanghechen/observable@5.0.4) (2023-08-08)
-
-
-### Performance Improvements
-
-* ⬆️ upgrade dependencies ([bbc1ae6](https://github.com/guanghechen/node-scaffolds/commit/bbc1ae6b40aa4030f4103035f062dd4040a35b08))
-
-
-
-
-
-## [5.0.3](https://github.com/guanghechen/node-scaffolds/compare/@guanghechen/observable@5.0.2...@guanghechen/observable@5.0.3) (2023-07-25)
-
-
-### Performance Improvements
-
-* 🔧 update npm script ([4ffc90a](https://github.com/guanghechen/node-scaffolds/commit/4ffc90aff15c75fcc6afeeabf4d83dbc8c1b7933))
-* ⬆️ upgrade dependencies ([a9b6097](https://github.com/guanghechen/node-scaffolds/commit/a9b609785175e91903ca8215a807691ba6fbc419))
-
-
-
-
-
-## [5.0.2](https://github.com/guanghechen/node-scaffolds/compare/@guanghechen/observable@5.0.1...@guanghechen/observable@5.0.2) (2023-07-15)
-
-
-### Performance Improvements
-
-* ⬆️ upgrade dependencies ([4f0f471](https://github.com/guanghechen/node-scaffolds/commit/4f0f4712d061099ea9d5605efeb54357e4479f6a))
-
-
-
-
-
-## [5.0.1](https://github.com/guanghechen/node-scaffolds/compare/@guanghechen/observable@5.0.0...@guanghechen/observable@5.0.1) (2023-05-26)
-
-
-### Performance Improvements
-
-* 🔧 update jest config to reuse tsconfig for test ([54883f0](https://github.com/guanghechen/node-scaffolds/commit/54883f032cbba78af4609d6d4fb2b5e1ac68b518))
-
-
-
-
-
-# 5.0.0 (2023-05-13)
-
-
-### Performance Improvements
-
-* 📝 remove all CHANGELOG in repo ([40909ed](https://github.com/guanghechen/node-scaffolds/commit/40909ed439632e0c4b0cd817614e24fdeac2fa23))
-
-
-
-# 5.0.0-alpha.3 (2023-05-07)
-
-
-### Performance Improvements
-
-* :bookmark:  release ([b5a3423](https://github.com/guanghechen/node-scaffolds/commit/b5a3423a3dd338d13ac4247c2651f4693f9fe363))
-* ⬆️ upgrade devDependencies ([30a9c27](https://github.com/guanghechen/node-scaffolds/commit/30a9c27c22b8debcf8dd5b2652ec335458caf31c))
-
-
-
-# 5.0.0-alpha.2 (2023-05-01)
-
-
-### Features
-
-* ✨ add @guanghechen/observable ([e0ef27b](https://github.com/guanghechen/node-scaffolds/commit/e0ef27bcf22a2e9e05ff29fea05f6a4778ef3ebf))
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 6.0.1 (2024-03-09)
 
 ### Performance Improvements
 
-* 🔖 publish v5.0.0-alpha.2 ([708dd6d](https://github.com/guanghechen/node-scaffolds/commit/708dd6d721059e902c375e628c939b28664f3058))
+- refactor observable
+  ([777e6f4](https://github.com/guanghechen/sora/commit/777e6f41c958416a8e0f0cf9f23f9dfaac51d7c0))

package/lib/cjs/index.cjs

@@ -1,64 +1,206 @@
 'use strict';
 
-class Observable {
+var disposable = require('@guanghechen/disposable');
+var observable_types = require('@guanghechen/observable.types');
+
+const noop = (..._args) => { };
+const noopUnsubscribable = { unsubscribe: noop };
+const noopUnobservable = { unobserve: noop };
+const isObservable = (obj) => {
+    if (obj === null || typeof obj !== 'object')
+        return false;
+    return (typeof Reflect.get(obj, 'dispose') === 'function' &&
+        typeof Reflect.get(obj, 'disposed') === 'boolean' &&
+        typeof Reflect.get(obj, 'subscribe') === 'function' &&
+        typeof Reflect.get(obj, 'equals') === 'function' &&
+        typeof Reflect.get(obj, 'getSnapshot') === 'function' &&
+        typeof Reflect.get(obj, 'next') === 'function');
+};
+
+const defaultEquals = (x, y) => Object.is(x, y);
+class Observable extends disposable.BatchDisposable {
+    equals;
+    _delay;
     _subscribers;
-    _equals;
     _value;
-    _available;
-    constructor(defaultValue, equals) {
-        this._subscribers = new Set();
-        this._equals = equals ?? ((x, y) => x === y);
+    _updateTick;
+    _notifyTick;
+    _lastNotifiedValue;
+    _timer;
+    constructor(defaultValue, options = {}) {
+        super();
+        const { equals = defaultEquals } = options;
+        this._delay = Math.max(0, Number(options.delay) || 0);
+        this._subscribers = [];
         this._value = defaultValue;
-        this._available = true;
-    }
-    get subscribers() {
-        return Array.from(this._subscribers.values());
-    }
-    get disposed() {
-        return !this._available;
+        this._updateTick = 0;
+        this._notifyTick = 0;
+        this._lastNotifiedValue = undefined;
+        this._timer = undefined;
+        this.equals = equals;
     }
     dispose() {
-        this._available = false;
-        this._subscribers.clear();
-    }
-    getSnapshot = () => {
-        return this._value;
-    };
-    next(value) {
-        if (this._available && !this._equals(value, this._value)) {
-            this._value = value;
-            const subscribers = this.subscribers;
-            for (const subscriber of subscribers)
-                subscriber.next(value);
+        if (this.disposed)
+            return;
+        super.dispose();
+        this._flush();
+        const batcher = new disposable.SafeBatchHandler();
+        const size = this._subscribers.length;
+        for (let i = 0; i < size; ++i) {
+            const item = this._subscribers[i];
+            if (item.inactive || item.subscriber.disposed)
+                continue;
+            batcher.run(() => item.subscriber.dispose());
         }
+        this._subscribers.length = 0;
+        batcher.summary();
     }
-    error(error) {
-        if (this._available) {
-            const subscribers = this.subscribers;
-            for (const subscriber of subscribers)
-                subscriber.error(error);
-            this.dispose();
-        }
+    getSnapshot() {
+        return this._value;
     }
-    complete() {
-        if (this._available) {
-            const subscribers = this.subscribers;
-            for (const subscriber of subscribers)
-                subscriber.complete();
-            this.dispose();
+    next(value, options) {
+        if (this.disposed) {
+            const strict = options?.strict ?? true;
+            if (strict) {
+                throw new RangeError(`Don't update a disposed observable. value: ${String(value)}.`);
+            }
+            return;
         }
+        const force = options?.force ?? false;
+        if (!force && this.equals(value, this._value))
+            return;
+        this._value = value;
+        this._updateTick += 1;
+        this._notify();
     }
     subscribe(subscriber) {
-        if (!this._subscribers.has(subscriber)) {
-            subscriber.next(this.getSnapshot());
-            this._subscribers.add(subscriber);
+        if (subscriber.disposed)
+            return noopUnsubscribable;
+        if (this.disposed) {
+            subscriber.dispose();
+            return noopUnsubscribable;
         }
+        const prevValue = this._lastNotifiedValue;
+        const value = this._value;
+        this._flush();
+        const item = { subscriber, inactive: false };
+        this._subscribers.push(item);
+        subscriber.next(value, prevValue);
         return {
             unsubscribe: () => {
-                this._subscribers.delete(subscriber);
+                item.inactive = true;
             },
         };
     }
+    _flush() {
+        if (this._notifyTick < this._updateTick) {
+            if (this._timer !== undefined) {
+                clearTimeout(this._timer);
+                this._timer = undefined;
+            }
+            this._notifyImmediate();
+        }
+    }
+    _notify() {
+        if (this._notifyTick < this._updateTick) {
+            if (this._delay <= 0) {
+                this._notifyImmediate();
+                return;
+            }
+            if (this._timer === undefined) {
+                this._timer = setTimeout(() => {
+                    try {
+                        this._notifyImmediate();
+                    }
+                    finally {
+                        this._timer = undefined;
+                    }
+                    this._notify();
+                }, this._delay);
+            }
+        }
+    }
+    _notifyImmediate() {
+        const prevValue = this._lastNotifiedValue;
+        const value = this._value;
+        this._lastNotifiedValue = value;
+        this._notifyTick = this._updateTick;
+        const batcher = new disposable.SafeBatchHandler();
+        const subscribers = this._subscribers;
+        const size = subscribers.length;
+        for (let i = 0; i < size; ++i) {
+            const subscriber = subscribers[i];
+            if (subscriber.inactive || subscriber.subscriber.disposed)
+                continue;
+            batcher.run(() => subscriber.subscriber.next(value, prevValue));
+        }
+        batcher.summary();
+    }
+}
+
+class Subscriber {
+    _onDispose;
+    _onNext;
+    _disposed;
+    constructor(options) {
+        this._onDispose = options?.onDispose ?? noop;
+        this._onNext = options.onNext;
+        this._disposed = false;
+    }
+    get disposed() {
+        return this._disposed;
+    }
+    dispose() {
+        if (this._disposed)
+            return;
+        this._disposed = true;
+        this._onDispose();
+    }
+    next(value, prevValue) {
+        if (this._disposed)
+            return;
+        this._onNext(value, prevValue);
+    }
+}
+
+const equals = (x, y) => x === y;
+class Ticker extends Observable {
+    constructor(options = {}) {
+        const { start = 0, delay } = options;
+        super(start, { delay, equals });
+    }
+    tick(options) {
+        this.next(this._value + 1, options);
+    }
+    observe(observable, options) {
+        if (this.disposed) {
+            const strict = options?.strict ?? true;
+            if (strict)
+                throw new RangeError('[Ticker.observe] the ticker has been disposed.');
+            return noopUnobservable;
+        }
+        if (observable.disposed)
+            return noopUnobservable;
+        const subscriber = new Subscriber({
+            onNext: () => this.tick(),
+            onDispose: () => unsubscribable.unsubscribe(),
+        });
+        const unsubscribable = observable.subscribe(subscriber);
+        this.registerDisposable(subscriber);
+        return { unobserve: () => unsubscribable.unsubscribe() };
+    }
 }
 
 exports.Observable = Observable;
+exports.Subscriber = Subscriber;
+exports.Ticker = Ticker;
+exports.isObservable = isObservable;
+exports.noop = noop;
+exports.noopUnobservable = noopUnobservable;
+exports.noopUnsubscribable = noopUnsubscribable;
+Object.keys(observable_types).forEach(function (k) {
+    if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
+        enumerable: true,
+        get: function () { return observable_types[k]; }
+    });
+});

package/lib/esm/index.mjs

@@ -1,62 +1,192 @@
-class Observable {
+import { BatchDisposable, SafeBatchHandler } from '@guanghechen/disposable';
+export * from '@guanghechen/observable.types';
+
+const noop = (..._args) => { };
+const noopUnsubscribable = { unsubscribe: noop };
+const noopUnobservable = { unobserve: noop };
+const isObservable = (obj) => {
+    if (obj === null || typeof obj !== 'object')
+        return false;
+    return (typeof Reflect.get(obj, 'dispose') === 'function' &&
+        typeof Reflect.get(obj, 'disposed') === 'boolean' &&
+        typeof Reflect.get(obj, 'subscribe') === 'function' &&
+        typeof Reflect.get(obj, 'equals') === 'function' &&
+        typeof Reflect.get(obj, 'getSnapshot') === 'function' &&
+        typeof Reflect.get(obj, 'next') === 'function');
+};
+
+const defaultEquals = (x, y) => Object.is(x, y);
+class Observable extends BatchDisposable {
+    equals;
+    _delay;
     _subscribers;
-    _equals;
     _value;
-    _available;
-    constructor(defaultValue, equals) {
-        this._subscribers = new Set();
-        this._equals = equals ?? ((x, y) => x === y);
+    _updateTick;
+    _notifyTick;
+    _lastNotifiedValue;
+    _timer;
+    constructor(defaultValue, options = {}) {
+        super();
+        const { equals = defaultEquals } = options;
+        this._delay = Math.max(0, Number(options.delay) || 0);
+        this._subscribers = [];
         this._value = defaultValue;
-        this._available = true;
-    }
-    get subscribers() {
-        return Array.from(this._subscribers.values());
-    }
-    get disposed() {
-        return !this._available;
+        this._updateTick = 0;
+        this._notifyTick = 0;
+        this._lastNotifiedValue = undefined;
+        this._timer = undefined;
+        this.equals = equals;
     }
     dispose() {
-        this._available = false;
-        this._subscribers.clear();
-    }
-    getSnapshot = () => {
-        return this._value;
-    };
-    next(value) {
-        if (this._available && !this._equals(value, this._value)) {
-            this._value = value;
-            const subscribers = this.subscribers;
-            for (const subscriber of subscribers)
-                subscriber.next(value);
+        if (this.disposed)
+            return;
+        super.dispose();
+        this._flush();
+        const batcher = new SafeBatchHandler();
+        const size = this._subscribers.length;
+        for (let i = 0; i < size; ++i) {
+            const item = this._subscribers[i];
+            if (item.inactive || item.subscriber.disposed)
+                continue;
+            batcher.run(() => item.subscriber.dispose());
         }
+        this._subscribers.length = 0;
+        batcher.summary();
     }
-    error(error) {
-        if (this._available) {
-            const subscribers = this.subscribers;
-            for (const subscriber of subscribers)
-                subscriber.error(error);
-            this.dispose();
-        }
+    getSnapshot() {
+        return this._value;
     }
-    complete() {
-        if (this._available) {
-            const subscribers = this.subscribers;
-            for (const subscriber of subscribers)
-                subscriber.complete();
-            this.dispose();
+    next(value, options) {
+        if (this.disposed) {
+            const strict = options?.strict ?? true;
+            if (strict) {
+                throw new RangeError(`Don't update a disposed observable. value: ${String(value)}.`);
+            }
+            return;
         }
+        const force = options?.force ?? false;
+        if (!force && this.equals(value, this._value))
+            return;
+        this._value = value;
+        this._updateTick += 1;
+        this._notify();
     }
     subscribe(subscriber) {
-        if (!this._subscribers.has(subscriber)) {
-            subscriber.next(this.getSnapshot());
-            this._subscribers.add(subscriber);
+        if (subscriber.disposed)
+            return noopUnsubscribable;
+        if (this.disposed) {
+            subscriber.dispose();
+            return noopUnsubscribable;
         }
+        const prevValue = this._lastNotifiedValue;
+        const value = this._value;
+        this._flush();
+        const item = { subscriber, inactive: false };
+        this._subscribers.push(item);
+        subscriber.next(value, prevValue);
         return {
             unsubscribe: () => {
-                this._subscribers.delete(subscriber);
+                item.inactive = true;
             },
         };
     }
+    _flush() {
+        if (this._notifyTick < this._updateTick) {
+            if (this._timer !== undefined) {
+                clearTimeout(this._timer);
+                this._timer = undefined;
+            }
+            this._notifyImmediate();
+        }
+    }
+    _notify() {
+        if (this._notifyTick < this._updateTick) {
+            if (this._delay <= 0) {
+                this._notifyImmediate();
+                return;
+            }
+            if (this._timer === undefined) {
+                this._timer = setTimeout(() => {
+                    try {
+                        this._notifyImmediate();
+                    }
+                    finally {
+                        this._timer = undefined;
+                    }
+                    this._notify();
+                }, this._delay);
+            }
+        }
+    }
+    _notifyImmediate() {
+        const prevValue = this._lastNotifiedValue;
+        const value = this._value;
+        this._lastNotifiedValue = value;
+        this._notifyTick = this._updateTick;
+        const batcher = new SafeBatchHandler();
+        const subscribers = this._subscribers;
+        const size = subscribers.length;
+        for (let i = 0; i < size; ++i) {
+            const subscriber = subscribers[i];
+            if (subscriber.inactive || subscriber.subscriber.disposed)
+                continue;
+            batcher.run(() => subscriber.subscriber.next(value, prevValue));
+        }
+        batcher.summary();
+    }
+}
+
+class Subscriber {
+    _onDispose;
+    _onNext;
+    _disposed;
+    constructor(options) {
+        this._onDispose = options?.onDispose ?? noop;
+        this._onNext = options.onNext;
+        this._disposed = false;
+    }
+    get disposed() {
+        return this._disposed;
+    }
+    dispose() {
+        if (this._disposed)
+            return;
+        this._disposed = true;
+        this._onDispose();
+    }
+    next(value, prevValue) {
+        if (this._disposed)
+            return;
+        this._onNext(value, prevValue);
+    }
+}
+
+const equals = (x, y) => x === y;
+class Ticker extends Observable {
+    constructor(options = {}) {
+        const { start = 0, delay } = options;
+        super(start, { delay, equals });
+    }
+    tick(options) {
+        this.next(this._value + 1, options);
+    }
+    observe(observable, options) {
+        if (this.disposed) {
+            const strict = options?.strict ?? true;
+            if (strict)
+                throw new RangeError('[Ticker.observe] the ticker has been disposed.');
+            return noopUnobservable;
+        }
+        if (observable.disposed)
+            return noopUnobservable;
+        const subscriber = new Subscriber({
+            onNext: () => this.tick(),
+            onDispose: () => unsubscribable.unsubscribe(),
+        });
+        const unsubscribable = observable.subscribe(subscriber);
+        this.registerDisposable(subscriber);
+        return { unobserve: () => unsubscribable.unsubscribe() };
+    }
 }
 
-export { Observable };
+export { Observable, Subscriber, Ticker, isObservable, noop, noopUnobservable, noopUnsubscribable };

package/lib/types/index.d.ts

@@ -1,38 +1,55 @@
-interface IDisposable {
-    readonly disposed: boolean;
-    dispose(): void;
-}
-type IEquals<T> = (x: T, y: T) => boolean;
-interface IUnsubscribable {
-    unsubscribe(): void;
+import { BatchDisposable } from '@guanghechen/disposable';
+import { IObservable, IEquals, IObservableOptions, IObservableNextOptions, ISubscriber, IUnsubscribable, ITicker, ITickerOptions, ITickerObserveOptions, IUnobservable } from '@guanghechen/observable.types';
+export * from '@guanghechen/observable.types';
+
+interface IObservableSubscriber<T> {
+    readonly subscriber: ISubscriber<T>;
+    inactive: boolean;
 }
-interface ISubscribable<T> {
+declare class Observable<T> extends BatchDisposable implements IObservable<T> {
+    readonly equals: IEquals<T>;
+    protected readonly _delay: number;
+    protected readonly _subscribers: Array<IObservableSubscriber<T>>;
+    protected _value: T;
+    protected _updateTick: number;
+    protected _notifyTick: number;
+    protected _lastNotifiedValue: T | undefined;
+    protected _timer: ReturnType<typeof setTimeout> | undefined;
+    constructor(defaultValue: T, options?: IObservableOptions<T>);
+    dispose(): void;
+    getSnapshot(): T;
+    next(value: T, options?: IObservableNextOptions): void;
     subscribe(subscriber: ISubscriber<T>): IUnsubscribable;
-}
-interface ISubscriber<T> {
-    next(value: T): void;
-    error(err: any): void;
-    complete(): void;
+    protected _flush(): void;
+    protected _notify(): void;
+    protected _notifyImmediate(): void;
 }
 
-declare class Observable<T> implements IDisposable, ISubscribable<T>, ISubscriber<T> {
-    protected readonly _subscribers: Set<ISubscriber<T>>;
-    protected readonly _equals: IEquals<T>;
-    protected _value: T;
-    protected _available: boolean;
-    constructor(defaultValue: T, equals?: IEquals<T>);
-    get subscribers(): Array<ISubscriber<T>>;
+type IOnDisposable = () => void;
+type IOnNext<T> = (value: T, prevValue: T | undefined) => void;
+interface ISubscriberOptions<T> {
+    readonly onNext: IOnNext<T>;
+    readonly onDispose?: IOnDisposable;
+}
+declare class Subscriber<T> implements ISubscriber<T> {
+    protected readonly _onDispose: IOnDisposable;
+    protected readonly _onNext: IOnNext<T>;
+    protected _disposed: boolean;
+    constructor(options: ISubscriberOptions<T>);
     get disposed(): boolean;
     dispose(): void;
-    getSnapshot: () => T;
-    /**
-     * 1. Update observable current state.
-     * 2. Notify all subscribers if the value is changed.
-     */
-    next(value: T): void;
-    error(error: unknown): void;
-    complete(): void;
-    subscribe(subscriber: ISubscriber<T>): IUnsubscribable;
+    next(value: T, prevValue: T | undefined): void;
 }
 
-export { IDisposable, IEquals, ISubscribable, ISubscriber, IUnsubscribable, Observable };
+declare class Ticker extends Observable<number> implements ITicker {
+    constructor(options?: ITickerOptions);
+    tick(options?: IObservableNextOptions): void;
+    observe<T>(observable: IObservable<T>, options?: ITickerObserveOptions): IUnobservable;
+}
+
+declare const noop: (..._args: any[]) => void;
+declare const noopUnsubscribable: IUnsubscribable;
+declare const noopUnobservable: IUnobservable;
+declare const isObservable: (obj: unknown) => obj is IObservable<unknown>;
+
+export { type ISubscriberOptions, Observable, Subscriber, Ticker, isObservable, noop, noopUnobservable, noopUnsubscribable };

package/package.json

@@ -1,33 +1,30 @@
 {
   "name": "@guanghechen/observable",
-  "version": "5.0.4",
-  "description": "A simple observable for subscript/notification pattern.",
+  "version": "6.0.1",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/observable@5.0.3",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.0.0",
     "directory": "packages/observable"
   },
-  "homepage": "https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/observable@5.0.3/packages/observable#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.0.0/packages/observable#readme",
   "keywords": [
     "observable"
   ],
   "type": "module",
-  "main": "./lib/cjs/index.cjs",
-  "module": "./lib/esm/index.mjs",
   "exports": {
-    "import": "./lib/esm/index.mjs",
-    "require": "./lib/cjs/index.cjs"
+    "types": "./lib/types/index.d.ts",
+    "require": "./lib/cjs/index.cjs",
+    "import": "./lib/esm/index.mjs"
   },
-  "types": "lib/types/index.d.ts",
-  "source": "src/index.ts",
+  "types": "./lib/types/index.d.ts",
+  "main": "./lib/cjs/index.cjs",
+  "module": "./lib/esm/index.mjs",
+  "source": "./src/index.ts",
   "license": "MIT",
-  "engines": {
-    "node": ">= 16.0.0"
-  },
   "files": [
     "lib/",
     "!lib/**/*.map",
@@ -36,16 +33,10 @@
     "LICENSE",
     "README.md"
   ],
-  "scripts": {
-    "build": "rimraf lib/ && cross-env NODE_ENV=production rollup -c ../../rollup.config.mjs",
-    "prepublishOnly": "yarn build",
-    "test": "node --experimental-vm-modules ../../node_modules/.bin/jest --config ../../jest.config.mjs --rootDir ."
-  },
-  "devDependencies": {
-    "cross-env": "^7.0.3",
-    "jest": "^29.6.2",
-    "rimraf": "^5.0.1",
-    "rollup": "^3.27.2"
+  "dependencies": {
+    "@guanghechen/disposable": "^1.0.0-alpha.3",
+    "@guanghechen/error.types": "^1.0.1",
+    "@guanghechen/observable.types": "^6.0.1"
   },
-  "gitHead": "f408fc18577b2b7006bcd6a2ed4a6e3b6546a8aa"
+  "gitHead": "8f4595ed8e3b21ac509a16aeb52cbb686636d9f0"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020-2023 guanghechen (https://github.com/guanghechen)
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,74 +0,0 @@
-<header>
-  <h1 align="center">
-    <a href="https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/observable@5.0.4/packages/observable#readme">@guanghechen/observable</a>
-  </h1>
-  <div align="center">
-    <a href="https://www.npmjs.com/package/@guanghechen/observable">
-      <img
-        alt="Npm Version"
-        src="https://img.shields.io/npm/v/@guanghechen/observable.svg"
-      />
-    </a>
-    <a href="https://www.npmjs.com/package/@guanghechen/observable">
-      <img
-        alt="Npm Download"
-        src="https://img.shields.io/npm/dm/@guanghechen/observable.svg"
-      />
-    </a>
-    <a href="https://www.npmjs.com/package/@guanghechen/observable">
-      <img
-        alt="Npm License"
-        src="https://img.shields.io/npm/l/@guanghechen/observable.svg"
-      />
-    </a>
-    <a href="#install">
-      <img
-        alt="Module formats: cjs, esm"
-        src="https://img.shields.io/badge/module_formats-cjs%2C%20esm-green.svg"
-      />
-    </a>
-    <a href="https://github.com/nodejs/node">
-      <img
-        alt="Node.js Version"
-        src="https://img.shields.io/node/v/@guanghechen/observable"
-      />
-    </a>
-    <a href="https://github.com/facebook/jest">
-      <img
-        alt="Tested with Jest"
-        src="https://img.shields.io/badge/tested_with-jest-9c465e.svg"
-      />
-    </a>
-    <a href="https://github.com/prettier/prettier">
-      <img
-        alt="Code Style: prettier"
-        src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
-      />
-    </a>
-  </div>
-</header>
-<br/>
-
-
-A simple observable for subscript/notification pattern.
-
-
-## Install
-
-  ```bash
-  npm install --save @guanghechen/observable
-  ```
-
-* yarn
-
-  ```bash
-  yarn add @guanghechen/observable
-  ```
-
-
-## Usage
-
-* Basic
-
-
-[homepage]: https://github.com/guanghechen/node-scaffolds/tree/@guanghechen/observable@5.0.4/packages/observable#readme