feat(rippling): store.sub support AbortSignal

e7h4n · Dec 9, 2024 · fa29c0f · fa29c0f
1 parent 6fa5c7a
commit fa29c0f
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/.changeset/clean-cooks-swim.md b/.changeset/clean-cooks-swim.md
@@ -0,0 +1,5 @@
+---
+'rippling': minor
+---
+
+feat: store.sub support AbortSignal
diff --git a/packages/rippling/src/core/store.ts b/packages/rippling/src/core/store.ts
@@ -1,5 +1,5 @@
 import type { ReadableAtom, Effect, Getter, Value, Updater, Setter } from '../../types/core/atom';
-import type { Store } from '../../types/core/store';
+import type { Store, SubscribeOptions } from '../../types/core/store';
 import { AtomManager, ListenerManager } from './atom-manager';
 
 export class StoreImpl implements Store {
@@ -75,7 +75,11 @@ export class StoreImpl implements Store {
     };
   }
 
-  sub(atoms: ReadableAtom<unknown>[] | ReadableAtom<unknown>, cbEffect: Effect<unknown, unknown[]>): () => void {
+  sub(
+    atoms: ReadableAtom<unknown>[] | ReadableAtom<unknown>,
+    cbEffect: Effect<unknown, unknown[]>,
+    options?: SubscribeOptions,
+  ): () => void {
     if (Array.isArray(atoms) && atoms.length === 0) {
       return () => void 0;
     }
@@ -91,6 +95,12 @@ export class StoreImpl implements Store {
       unsubscribes.add(this._subSingleAtom(atom, cbEffect));
     });
 
+    options?.signal?.addEventListener('abort', () => {
+      for (const unsubscribe of unsubscribes) {
+        unsubscribe();
+      }
+    });
+
     return () => {
       for (const unsubscribe of unsubscribes) {
         unsubscribe();

diff --git a/packages/rippling/src/react/useGet.ts b/packages/rippling/src/react/useGet.ts
@@ -7,7 +7,11 @@ export function useGet<T>(atom: Value<T> | Computed<T>) {
   const store = useStore();
   return useSyncExternalStore(
     (fn) => {
-      return store.sub(atom, $effect(fn));
+      const ctrl = new AbortController();
+      store.sub(atom, $effect(fn), { signal: ctrl.signal });
+      return () => {
+        ctrl.abort();
+      };
     },
     () => {
       return store.get(atom);

diff --git a/packages/rippling/types/core/store.ts b/packages/rippling/types/core/store.ts
@@ -6,7 +6,12 @@ export interface Store {
   sub: Subscribe;
 }
 
+export interface SubscribeOptions {
+  signal?: AbortSignal;
+}
+
 export type Subscribe = (
   atoms: ReadableAtom<unknown>[] | ReadableAtom<unknown>,
   callback: Effect<unknown, unknown[]>,
+  options?: SubscribeOptions,
 ) => () => void;