@guanghechen/observable 5.0.0-alpha.2

package/LICENSE

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,74 @@
+<header>
+  <h1 align="center">
+    <a href="https://github.com/guanghechen/node-scaffolds/tree/release-5.x.x/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/release-5.x.x/packages/observable#readme

package/lib/cjs/index.cjs

@@ -0,0 +1,64 @@
+'use strict';
+
+class Observable {
+    _subscribers;
+    _equals;
+    _value;
+    _available;
+    constructor(defaultValue, equals) {
+        this._subscribers = new Set();
+        this._equals = equals ?? ((x, y) => x === y);
+        this._value = defaultValue;
+        this._available = true;
+    }
+    get subscribers() {
+        return Array.from(this._subscribers.values());
+    }
+    get disposed() {
+        return !this._available;
+    }
+    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);
+        }
+    }
+    error(error) {
+        if (this._available) {
+            const subscribers = this.subscribers;
+            for (const subscriber of subscribers)
+                subscriber.error(error);
+            this.dispose();
+        }
+    }
+    complete() {
+        if (this._available) {
+            const subscribers = this.subscribers;
+            for (const subscriber of subscribers)
+                subscriber.complete();
+            this.dispose();
+        }
+    }
+    subscribe(subscriber) {
+        if (!this._subscribers.has(subscriber)) {
+            subscriber.next(this.getSnapshot());
+            this._subscribers.add(subscriber);
+        }
+        return {
+            unsubscribe: () => {
+                this._subscribers.delete(subscriber);
+            },
+        };
+    }
+}
+
+exports.Observable = Observable;

package/lib/esm/index.mjs

@@ -0,0 +1,62 @@
+class Observable {
+    _subscribers;
+    _equals;
+    _value;
+    _available;
+    constructor(defaultValue, equals) {
+        this._subscribers = new Set();
+        this._equals = equals ?? ((x, y) => x === y);
+        this._value = defaultValue;
+        this._available = true;
+    }
+    get subscribers() {
+        return Array.from(this._subscribers.values());
+    }
+    get disposed() {
+        return !this._available;
+    }
+    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);
+        }
+    }
+    error(error) {
+        if (this._available) {
+            const subscribers = this.subscribers;
+            for (const subscriber of subscribers)
+                subscriber.error(error);
+            this.dispose();
+        }
+    }
+    complete() {
+        if (this._available) {
+            const subscribers = this.subscribers;
+            for (const subscriber of subscribers)
+                subscriber.complete();
+            this.dispose();
+        }
+    }
+    subscribe(subscriber) {
+        if (!this._subscribers.has(subscriber)) {
+            subscriber.next(this.getSnapshot());
+            this._subscribers.add(subscriber);
+        }
+        return {
+            unsubscribe: () => {
+                this._subscribers.delete(subscriber);
+            },
+        };
+    }
+}
+
+export { Observable };

package/lib/types/index.d.ts

@@ -0,0 +1,38 @@
+interface IDisposable {
+    readonly disposed: boolean;
+    dispose(): void;
+}
+type IEquals<T> = (x: T, y: T) => boolean;
+interface IUnsubscribable {
+    unsubscribe(): void;
+}
+interface ISubscribable<T> {
+    subscribe(subscriber: ISubscriber<T>): IUnsubscribable;
+}
+interface ISubscriber<T> {
+    next(value: T): void;
+    error(err: any): void;
+    complete(): 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>>;
+    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;
+}
+
+export { IDisposable, IEquals, ISubscribable, ISubscriber, IUnsubscribable, Observable };

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@guanghechen/observable",
+  "version": "5.0.0-alpha.2",
+  "description": "A simple observable for subscript/notification pattern.",
+  "author": {
+    "name": "guanghechen",
+    "url": "https://github.com/guanghechen/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/guanghechen/node-scaffolds/tree/release-5.x.x",
+    "directory": "packages/observable"
+  },
+  "homepage": "https://github.com/guanghechen/node-scaffolds/tree/release-5.x.x/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",
+  "source": "src/index.ts",
+  "license": "MIT",
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "files": [
+    "lib/",
+    "!lib/**/*.map",
+    "package.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rimraf lib/ && cross-env NODE_ENV=production rollup -c ../../rollup.config.mjs",
+    "prepublishOnly": "yarn build",
+    "test": "cross-env TS_NODE_FILES=true NODE_OPTIONS=--experimental-vm-modules jest --config ../../jest.config.mjs --rootDir ."
+  },
+  "devDependencies": {
+    "cross-env": "^7.0.3",
+    "jest": "^29.5.0",
+    "rimraf": "^5.0.0",
+    "rollup": "^3.21.1"
+  },
+  "gitHead": "708dd6d721059e902c375e628c939b28664f3058"
+}