@guanghechen/observable 6.0.3 → 6.1.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file. See
 [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [6.1.0](https://github.com/guanghechen/sora/compare/@guanghechen/observable@6.0.3...@guanghechen/observable@6.1.0) (2024-03-10)
+
+### Features
+
+- ✨ add @guanghechen/subscriber
+  ([ba57528](https://github.com/guanghechen/sora/commit/ba575283cd159e21896dfab062eff0b5da216757))
+
+### Performance Improvements
+
+- 🎨 refaactor observable with subscriber & remove observable.types
+  ([bac2118](https://github.com/guanghechen/sora/commit/bac211888713cac920154efb593dbbcf903ab33e))
+
+# Change Log
+
+All notable changes to this project will be documented in this file. See
+[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
 ## [6.0.3](https://github.com/guanghechen/sora/compare/@guanghechen/observable@6.0.2...@guanghechen/observable@6.0.3) (2024-03-10)
 
 ### Performance Improvements

package/lib/cjs/index.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
 var disposable = require('@guanghechen/disposable');
-var observable_types = require('@guanghechen/observable.types');
+var subscriber = require('@guanghechen/subscriber');
 
 const noop = (..._args) => { };
 const noopUnsubscribable = { unsubscribe: noop };
@@ -31,7 +31,7 @@ class Observable extends disposable.BatchDisposable {
         super();
         const { equals = defaultEquals } = options;
         this._delay = Math.max(0, Number(options.delay) || 0);
-        this._subscribers = [];
+        this._subscribers = new subscriber.Subscribers();
         this._value = defaultValue;
         this._updateTick = 0;
         this._notifyTick = 0;
@@ -44,19 +44,7 @@ class Observable extends disposable.BatchDisposable {
             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());
-        }
-        for (const item of this._subscribers)
-            item.inactive = true;
-        this._subscribers.length = 0;
-        batcher.summary('[observable] Encountered errors while disposing.');
-        batcher.cleanup();
+        this._subscribers.dispose();
     }
     getSnapshot() {
         return this._value;
@@ -87,14 +75,8 @@ class Observable extends disposable.BatchDisposable {
             return noopUnsubscribable;
         }
         this._flush();
-        const item = { subscriber, inactive: false };
-        this._subscribers.push(item);
         subscriber.next(value, prevValue);
-        return {
-            unsubscribe: () => {
-                item.inactive = true;
-            },
-        };
+        return this._subscribers.subscribe(subscriber);
     }
     _flush() {
         if (this._notifyTick < this._updateTick) {
@@ -129,42 +111,7 @@ class Observable extends disposable.BatchDisposable {
         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('[observable] Encountered errors while notifying subscribers.');
-        batcher.cleanup();
-    }
-}
-
-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);
+        this._subscribers.notify(value, prevValue);
     }
 }
 
@@ -186,25 +133,18 @@ class Ticker extends Observable {
         }
         if (observable.disposed)
             return noopUnobservable;
-        const subscriber = new Subscriber({ onNext: () => this.tick() });
-        const unsubscribable = observable.subscribe(subscriber);
+        const subscriber$1 = new subscriber.Subscriber({ onNext: () => this.tick() });
+        const unsubscribable = observable.subscribe(subscriber$1);
         const disposable$1 = new disposable.Disposable(() => unsubscribable.unsubscribe());
-        this.registerDisposable(subscriber);
+        this.registerDisposable(subscriber$1);
         this.registerDisposable(disposable$1);
         return { unobserve: () => disposable$1.dispose() };
     }
 }
 
 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,5 +1,5 @@
-import { BatchDisposable, SafeBatchHandler, Disposable } from '@guanghechen/disposable';
-export * from '@guanghechen/observable.types';
+import { BatchDisposable, Disposable } from '@guanghechen/disposable';
+import { Subscribers, Subscriber } from '@guanghechen/subscriber';
 
 const noop = (..._args) => { };
 const noopUnsubscribable = { unsubscribe: noop };
@@ -29,7 +29,7 @@ class Observable extends BatchDisposable {
         super();
         const { equals = defaultEquals } = options;
         this._delay = Math.max(0, Number(options.delay) || 0);
-        this._subscribers = [];
+        this._subscribers = new Subscribers();
         this._value = defaultValue;
         this._updateTick = 0;
         this._notifyTick = 0;
@@ -42,19 +42,7 @@ class Observable extends BatchDisposable {
             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());
-        }
-        for (const item of this._subscribers)
-            item.inactive = true;
-        this._subscribers.length = 0;
-        batcher.summary('[observable] Encountered errors while disposing.');
-        batcher.cleanup();
+        this._subscribers.dispose();
     }
     getSnapshot() {
         return this._value;
@@ -85,14 +73,8 @@ class Observable extends BatchDisposable {
             return noopUnsubscribable;
         }
         this._flush();
-        const item = { subscriber, inactive: false };
-        this._subscribers.push(item);
         subscriber.next(value, prevValue);
-        return {
-            unsubscribe: () => {
-                item.inactive = true;
-            },
-        };
+        return this._subscribers.subscribe(subscriber);
     }
     _flush() {
         if (this._notifyTick < this._updateTick) {
@@ -127,42 +109,7 @@ class Observable extends BatchDisposable {
         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('[observable] Encountered errors while notifying subscribers.');
-        batcher.cleanup();
-    }
-}
-
-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);
+        this._subscribers.notify(value, prevValue);
     }
 }
 
@@ -193,4 +140,4 @@ class Ticker extends Observable {
     }
 }
 
-export { Observable, Subscriber, Ticker, isObservable, noop, noopUnobservable, noopUnsubscribable };
+export { Observable, Ticker, isObservable, noop, noopUnobservable, noopUnsubscribable };

package/lib/types/index.d.ts

@@ -1,15 +1,51 @@
-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';
+import { IBatchDisposable, BatchDisposable } from '@guanghechen/disposable';
+import { ISubscribable, ISubscribers, ISubscriber, IUnsubscribable } from '@guanghechen/subscriber';
 
-interface IObservableSubscriber<T> {
-    readonly subscriber: ISubscriber<T>;
-    inactive: boolean;
+type IEquals<T> = (x: T, y: T) => boolean;
+interface IObservableOptions<T> {
+    /**
+     * Delay before notifying subscribers. (milliseconds)
+     */
+    readonly delay?: number;
+    /**
+     * Determine whether the two values are equal.
+     */
+    readonly equals?: IEquals<T>;
 }
+interface IObservableNextOptions {
+    /**
+     * Whether to throw an error if the observable disposed.
+     * @default true
+     */
+    readonly strict?: boolean;
+    /**
+     * Force trigger the notification of subscribers even the next value is equals to the current value.
+     * @default false
+     */
+    readonly force?: boolean;
+}
+interface IObservable<T> extends IBatchDisposable, ISubscribable<T> {
+    readonly equals: IEquals<T>;
+    getSnapshot(): T;
+    next(value: T, options?: IObservableNextOptions): void;
+}
+type IValueList<T extends Array<IObservable<any>>> = {
+    [K in keyof T]: T[K] extends IObservable<infer U> ? U : never;
+};
+type IValueMap<T extends object> = {
+    [key in keyof T]: T[key] extends IObservable<infer U> ? U : never;
+};
+type IObservableRecord<T extends object> = {
+    [key in keyof T]: T[key] extends IObservable<any> ? T[key] : never;
+};
+type IObservableKey<T extends object> = keyof {
+    [key in keyof T]: T[key] extends IObservable<any> ? key : never;
+};
+
 declare class Observable<T> extends BatchDisposable implements IObservable<T> {
     readonly equals: IEquals<T>;
     protected readonly _delay: number;
-    protected readonly _subscribers: Array<IObservableSubscriber<T>>;
+    protected readonly _subscribers: ISubscribers<T>;
     protected _value: T;
     protected _updateTick: number;
     protected _notifyTick: number;
@@ -25,20 +61,43 @@ declare class Observable<T> extends BatchDisposable implements IObservable<T> {
     protected _notifyImmediate(): void;
 }
 
-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;
-    next(value: T, prevValue: T | undefined): void;
+/**
+ * A unobservable can be unobserved.
+ */
+interface IUnobservable {
+    /**
+     * Won't get notified from the observable after unobserved, but it could still not be completed.
+     */
+    unobserve(): void;
+}
+interface ITickerOptions {
+    /**
+     * The initial value of the ticker.
+     */
+    readonly start?: number;
+    /**
+     * Delay before notifying subscribers. (milliseconds)
+     */
+    readonly delay?: number;
+}
+interface ITickerObserveOptions {
+    /**
+     * Whether to throw an error if the observable disposed.
+     * @default true
+     */
+    readonly strict?: boolean;
+}
+interface ITicker extends IObservable<number> {
+    /**
+     * Trigger the ticker to update the value.
+     */
+    tick(options?: IObservableNextOptions): void;
+    /**
+     * Subscribe the change of an observable.
+     * @param observable
+     * @param options
+     */
+    observe(observable: IObservable<any>, options?: ITickerObserveOptions): void;
 }
 
 declare class Ticker extends Observable<number> implements ITicker {
@@ -52,4 +111,4 @@ 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 };
+export { type IEquals, type IObservable, type IObservableKey, type IObservableNextOptions, type IObservableOptions, type IObservableRecord, type ITicker, type ITickerObserveOptions, type ITickerOptions, type IUnobservable, type IValueList, type IValueMap, Observable, Ticker, isObservable, noop, noopUnobservable, noopUnsubscribable };

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@guanghechen/observable",
-  "version": "6.0.3",
+  "version": "6.1.0",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.0.2",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.0.3",
     "directory": "packages/observable"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.0.2/packages/observable#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.0.3/packages/observable#readme",
   "keywords": [
     "observable"
   ],
@@ -35,8 +35,7 @@
   ],
   "dependencies": {
     "@guanghechen/disposable": "^1.0.0-alpha.4",
-    "@guanghechen/error.types": "^1.0.1",
-    "@guanghechen/observable.types": "^6.0.1"
+    "@guanghechen/subscriber": "^1.0.0-alpha.1"
   },
-  "gitHead": "edc5a1b997fac81f96f1ba03200a13b829b3e91d"
+  "gitHead": "497dbbfba4b26ad22cdc2e9500ceca625d3ffac3"
 }