@guanghechen/observable 6.1.8 → 7.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present 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,6 +1,6 @@
 <header>
   <h1 align="center">
-    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.1.8/packages/observable#readme">@guanghechen/observable</a>
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/observable@7.0.0/packages/observable#readme">@guanghechen/observable</a>
   </h1>
   <div align="center">
     <a href="https://www.npmjs.com/package/@guanghechen/observable">
@@ -49,7 +49,8 @@
 </header>
 <br/>
 
-Observable pattern implementation with ticker functionality for reactive programming.
+Observable pattern implementation with ticker functionality for reactive programming. Provides value
+change notification with optional delay debouncing and custom equality comparison.
 
 ## Install
 
@@ -67,88 +68,120 @@ Observable pattern implementation with ticker functionality for reactive program
 
 ## Usage
 
-|       Name       |                        Description                        |
-| :--------------: | :-------------------------------------------------------: |
-|   `Observable`   |     Reactive observable value with change notification   |
-|    `Ticker`      |     Timer-based ticker for scheduled notifications       |
+### Basic Observable
 
-## Example
+```typescript
+import { Observable } from '@guanghechen/observable'
+import { Subscriber } from '@guanghechen/subscriber'
 
-- Basic observable:
+const count = new Observable<number>(0)
 
-  ```typescript
-  import { Observable } from '@guanghechen/observable'
-  import { Subscriber } from '@guanghechen/subscriber'
+const subscriber = new Subscriber({
+  onNext: (newValue, oldValue) => {
+    console.log(`Value changed from ${oldValue} to ${newValue}`)
+  }
+})
 
-  const observable = new Observable<number>(0)
+const unsubscribable = count.subscribe(subscriber)
 
-  // Create a subscriber
-  const subscriber = new Subscriber({
-    onNext: (newValue, oldValue) => {
-      console.log(`Value changed from ${oldValue} to ${newValue}`)
-    },
-    onDispose: () => {
-      console.log('Subscriber disposed')
-    }
-  })
+count.next(1) // "Value changed from 0 to 1"
+count.next(2) // "Value changed from 1 to 2"
+count.next(2) // No notification (same value)
 
-  // Subscribe to changes
-  const unsubscribe = observable.subscribe(subscriber)
+console.log(count.getSnapshot()) // 2
 
-  observable.next(1) // Output: "Value changed from undefined to 1"
-  observable.next(2) // Output: "Value changed from 1 to 2"
+unsubscribable.unsubscribe()
+count.dispose()
+```
 
-  unsubscribe.unsubscribe()
-  ```
+### Observable with Custom Equality
 
-- Observable with custom equality:
+```typescript
+import { Observable } from '@guanghechen/observable'
+import { Subscriber } from '@guanghechen/subscriber'
 
-  ```typescript
-  import { Observable } from '@guanghechen/observable'
-  import { Subscriber } from '@guanghechen/subscriber'
+interface IUser {
+  id: number
+  name: string
+}
 
-  const observable = new Observable<{id: number, name: string}>(
-    { id: 1, name: 'John' },
-    { equals: (a, b) => a.id === b.id }
-  )
+const user = new Observable<IUser>(
+  { id: 1, name: 'John' },
+  { equals: (a, b) => a.id === b.id }
+)
 
-  const subscriber = new Subscriber({
-    onNext: (newVal) => {
-      console.log('Object changed:', newVal)
-    }
-  })
+const subscriber = new Subscriber<IUser>({
+  onNext: (value) => console.log('User changed:', value)
+})
 
-  observable.subscribe(subscriber)
+user.subscribe(subscriber)
 
-  // This won't trigger notification (same id)
-  observable.next({ id: 1, name: 'Jane' })
+// This won't trigger notification (same id)
+user.next({ id: 1, name: 'Jane' })
 
-  // This will trigger notification (different id)
-  observable.next({ id: 2, name: 'Bob' })
-  ```
+// This will trigger notification (different id)
+user.next({ id: 2, name: 'Bob' })
 
-- Using ticker:
+// Force notification even if equal
+user.next({ id: 2, name: 'Bob Updated' }, { force: true })
+```
 
-  ```typescript
-  import { Ticker } from '@guanghechen/observable'
-  import { Subscriber } from '@guanghechen/subscriber'
+### Observable with Delay (Debouncing)
 
-  const ticker = new Ticker<string>('initial', { interval: 1000 })
+```typescript
+import { Observable } from '@guanghechen/observable'
+import { Subscriber } from '@guanghechen/subscriber'
 
-  const subscriber = new Subscriber({
-    onNext: (value) => {
-      console.log('Ticker value:', value)
-    }
-  })
+// Debounce notifications by 100ms
+const search = new Observable<string>('', { delay: 100 })
 
-  ticker.subscribe(subscriber)
-  ticker.start()
-  
-  // Update ticker value
-  setTimeout(() => {
-    ticker.next('updated value')
-  }, 2000)
-  ```
+const subscriber = new Subscriber<string>({
+  onNext: (value) => console.log('Search:', value)
+})
+
+search.subscribe(subscriber)
+
+// Rapid updates - only the last value will be notified after 100ms
+search.next('h')
+search.next('he')
+search.next('hel')
+search.next('hell')
+search.next('hello')
+// Output after 100ms: "Search: hello"
+```
+
+### Ticker
+
+Ticker is a specialized observable that increments a counter value:
+
+```typescript
+import { Observable, Ticker } from '@guanghechen/observable'
+import { Subscriber } from '@guanghechen/subscriber'
+
+const ticker = new Ticker({ start: 0, delay: 100 })
+
+const subscriber = new Subscriber<number>({
+  onNext: (tick) => console.log('Tick:', tick)
+})
+
+ticker.subscribe(subscriber)
+
+ticker.tick() // Tick: 1
+ticker.tick() // Tick: 2
+
+// Observe other observables - ticker increments when they change
+const name = new Observable<string>('John')
+const unobservable = ticker.observe(name)
+
+name.next('Jane') // Also triggers: Tick: 3
+
+unobservable.unobserve()
+ticker.dispose()
+```
+
+## Reference
+
+- [homepage][homepage]
 
 [homepage]:
-  https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.1.8/packages/observable#readme
+  https://github.com/guanghechen/sora/tree/@guanghechen/observable@7.0.0/packages/observable#readme

package/lib/cjs/index.cjs

@@ -22,6 +22,7 @@ class Observable extends disposable.BatchDisposable {
     equals;
     _delay;
     _subscribers;
+    _onError;
     _value;
     _updateTick;
     _notifyTick;
@@ -29,7 +30,7 @@ class Observable extends disposable.BatchDisposable {
     _timer;
     constructor(defaultValue, options = {}) {
         super();
-        const { equals = defaultEquals } = options;
+        const { equals = defaultEquals, onError } = options;
         this._delay = Math.max(0, Number(options.delay) || 0);
         this._subscribers = new subscriber.Subscribers();
         this._value = defaultValue;
@@ -38,6 +39,11 @@ class Observable extends disposable.BatchDisposable {
         this._lastNotifiedValue = undefined;
         this._timer = undefined;
         this.equals = equals;
+        this._onError =
+            onError ??
+                (error => {
+                    console.error('Error in observable notification:', error);
+                });
     }
     dispose() {
         if (this.disposed)
@@ -105,7 +111,7 @@ class Observable extends disposable.BatchDisposable {
                         }
                     }
                     catch (error) {
-                        console.error('Error in observable notification:', error);
+                        this._onError(error);
                     }
                     finally {
                         this._timer = undefined;

package/lib/esm/index.mjs

@@ -20,6 +20,7 @@ class Observable extends BatchDisposable {
     equals;
     _delay;
     _subscribers;
+    _onError;
     _value;
     _updateTick;
     _notifyTick;
@@ -27,7 +28,7 @@ class Observable extends BatchDisposable {
     _timer;
     constructor(defaultValue, options = {}) {
         super();
-        const { equals = defaultEquals } = options;
+        const { equals = defaultEquals, onError } = options;
         this._delay = Math.max(0, Number(options.delay) || 0);
         this._subscribers = new Subscribers();
         this._value = defaultValue;
@@ -36,6 +37,11 @@ class Observable extends BatchDisposable {
         this._lastNotifiedValue = undefined;
         this._timer = undefined;
         this.equals = equals;
+        this._onError =
+            onError ??
+                (error => {
+                    console.error('Error in observable notification:', error);
+                });
     }
     dispose() {
         if (this.disposed)
@@ -103,7 +109,7 @@ class Observable extends BatchDisposable {
                         }
                     }
                     catch (error) {
-                        console.error('Error in observable notification:', error);
+                        this._onError(error);
                     }
                     finally {
                         this._timer = undefined;

package/lib/types/index.d.ts

@@ -1,5 +1,6 @@
-import { IBatchDisposable, BatchDisposable } from '@guanghechen/disposable';
+import { BatchDisposable } from '@guanghechen/disposable';
 import { ISubscribable, ISubscribers, ISubscriber, IUnsubscribable } from '@guanghechen/subscriber';
+import { IBatchDisposable } from '@guanghechen/types';
 
 type IEquals<T> = (x: T, y: T) => boolean;
 interface IObservableOptions<T> {
@@ -11,6 +12,10 @@ interface IObservableOptions<T> {
      * Determine whether the two values are equal.
      */
     readonly equals?: IEquals<T>;
+    /**
+     * Error handler for async notifications.
+     */
+    readonly onError?: (error: unknown) => void;
 }
 interface IObservableNextOptions {
     /**
@@ -48,6 +53,7 @@ declare class Observable<T> extends BatchDisposable implements IObservable<T> {
     readonly equals: IEquals<T>;
     protected readonly _delay: number;
     protected readonly _subscribers: ISubscribers<T>;
+    protected readonly _onError: (error: unknown) => void;
     protected _value: T;
     protected _updateTick: number;
     protected _notifyTick: number;
@@ -108,7 +114,7 @@ declare class Ticker extends Observable<number> implements ITicker {
     observe<T>(observable: IBaseObservable<T>, options?: ITickerObserveOptions): IUnobservable;
 }
 
-declare const noop: (..._args: any[]) => void;
+declare const noop: (..._args: unknown[]) => void;
 declare const noopUnsubscribable: IUnsubscribable;
 declare const noopUnobservable: IUnobservable;
 declare const isObservable: (obj: unknown) => obj is IObservable<unknown>;

package/package.json

@@ -1,24 +1,27 @@
 {
   "name": "@guanghechen/observable",
-  "version": "6.1.8",
+  "version": "7.0.1",
   "author": {
     "name": "guanghechen",
     "url": "https://github.com/guanghechen/"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.1.7",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@7.0.0",
     "directory": "packages/observable"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@6.1.7/packages/observable#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/observable@7.0.0/packages/observable#readme",
   "keywords": [
     "observable"
   ],
   "type": "module",
   "exports": {
-    "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",
+      "import": "./lib/esm/index.mjs",
+      "require": "./lib/cjs/index.cjs"
+    }
   },
   "types": "./lib/types/index.d.ts",
   "main": "./lib/cjs/index.cjs",
@@ -34,8 +37,15 @@
     "README.md"
   ],
   "dependencies": {
-    "@guanghechen/disposable": "^1.0.3",
-    "@guanghechen/subscriber": "^1.0.3"
+    "@guanghechen/disposable": "^2.0.1",
+    "@guanghechen/subscriber": "^2.0.1",
+    "@guanghechen/types": "^2.0.1"
   },
-  "gitHead": "c288d8998c5fd2c7c33d5485bcc090018c81414d"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}