jrx 0.3.0-alpha.1 → 0.3.0-alpha.3

package/README.md

@@ -28,12 +28,12 @@ npm i jrx
 - [`makeReset()`](#makereset) - Create a resettable `DisposableStack`
 - [`makeAsyncReset()`](#makeasyncreset) - Create a resettable `AsyncDisposableStack`
 - [`makeRenderLoop()`](#makerenderloop) - Render loops with automatic cleanup
-- [`addInterval(cb, ms)`](#addintervalcb-ms) - Repeating intervals with cleanup
-- [`addIntervalAsync(cb, ms)`](#addintervalasynccb-ms) - Async intervals with cancellation
-- [`addRequestAnimationFrame(cb)`](#addrequestanimationframecb) - Single animation frame with cleanup
-- [`addRequestAnimationFrameLoop(cb)`](#addrequestanimationframeloopcb) - Animation frame loops
-- [`addTimeout(cb, ms)`](#addtimeoutcb-ms) - Timeouts with cleanup
-- [`addTransition(cb, durationMs)`](#addtransitioncb-durationms) - Progress-based animations
+- [`makeInterval(cb, ms)`](#makeintervalcb-ms) - Repeating intervals with cleanup
+- [`makeIntervalAsync(cb, ms)`](#makeintervalasynccb-ms) - Async intervals with cancellation
+- [`makeAnimationFrame(cb)`](#makeanimationframecb) - Single animation frame with cleanup
+- [`makeAnimationFrameLoop(cb)`](#makeanimationframeloopcb) - Animation frame loops
+- [`makeTimeout(cb, ms)`](#maketimeoutcb-ms) - Timeouts with cleanup
+- [`makeTransition(cb, durationMs)`](#maketransitioncb-durationms) - Progress-based animations
 - [`computed(fn, getDeps?)`](#computedfn-getdeps) - Memoized computed values
 - [`retry(cb, backoffSec?)`](#retrycb-backoffsec) - Retry with exponential backoff
 
@@ -76,13 +76,15 @@ import {makeRenderLoop} from 'jrx'
 
 const {loop, setLoop} = makeRenderLoop()
 
-// Set the loop function
-const dispose = setLoop((time) => {
+// Set the loop function - returns a Disposable
+const handle = setLoop((time) => {
   console.log('Frame time:', time)
 
-  // Optional: return cleanup function
-  return () => {
-    console.log('Cleanup previous frame')
+  // Optional: return a Disposable for cleanup
+  return {
+    [Symbol.dispose]() {
+      console.log('Cleanup previous frame')
+    },
   }
 })
 
@@ -90,121 +92,129 @@ const dispose = setLoop((time) => {
 requestAnimationFrame(loop)
 
 // Cleanup
-dispose()
+handle[Symbol.dispose]()
 ```
 
-### `addInterval(cb, ms)`
+### `makeInterval(cb, ms)`
 
-Creates a repeating interval with cleanup. The callback can optionally return a cleanup function that runs before the next invocation.
+Creates a repeating interval with cleanup. The callback can optionally return a `Disposable` that is disposed before the next invocation. Returns a `Disposable`.
 
 **Note:** The callback fires **immediately** on first call, then waits `ms` milliseconds **after** the previous callback completes. This is not a fixed-rate timer.
 
 ```typescript
-import { addInterval } from 'jrx'
+import {makeInterval} from 'jrx'
 
-const dispose = addInterval(() => {
+const handle = makeInterval(() => {
   console.log('Tick') // Called immediately, then every 1000ms after completion
 
-  // Optional: return cleanup function
-  return () => {
-    console.log('Cleanup')
+  // Optional: return a Disposable for cleanup
+  return {
+    [Symbol.dispose]() {
+      console.log('Cleanup')
+    },
   }
 }, 1000)
 
 // Stop the interval
-dispose()
+handle[Symbol.dispose]()
 ```
 
-### `addIntervalAsync(cb, ms)`
+### `makeIntervalAsync(cb, ms)`
 
-Async version of `addInterval`. Waits for the callback to complete before scheduling the next invocation.
+Async version of `makeInterval`. Waits for the callback to complete before scheduling the next invocation. Returns a `Disposable`.
 
 **Note:** The callback fires **immediately** on first call, then waits `ms` milliseconds **after** the previous async callback completes.
 
 ```typescript
-import { addIntervalAsync } from 'jrx'
+import {makeIntervalAsync} from 'jrx'
 
-const dispose = addIntervalAsync(async () => {
+const handle = makeIntervalAsync(async () => {
   // Called immediately, then 5000ms after each completion
   await fetchData()
   processData()
 }, 5000)
 
-dispose()
+handle[Symbol.dispose]()
 ```
 
-### `addRequestAnimationFrame(cb)`
+### `makeAnimationFrame(cb)`
 
-Executes a callback on the next animation frame with cleanup.
+Executes a callback on the next animation frame with cleanup. Returns a `Disposable`.
 
 ```typescript
-import { addRequestAnimationFrame } from 'jrx'
+import {makeAnimationFrame} from 'jrx'
 
-const dispose = addRequestAnimationFrame((now) => {
+const handle = makeAnimationFrame((now) => {
   updateAnimation(now)
 
-  // Optional: return cleanup function
-  return () => {
-    cleanupAnimation()
+  // Optional: return a Disposable for cleanup
+  return {
+    [Symbol.dispose]() {
+      cleanupAnimation()
+    },
   }
 })
 
 // Cancel if needed before the frame fires
-dispose()
+handle[Symbol.dispose]()
 ```
 
-### `addRequestAnimationFrameLoop(cb)`
+### `makeAnimationFrameLoop(cb)`
 
-Creates a continuous `requestAnimationFrame` loop with cleanup.
+Creates a continuous `requestAnimationFrame` loop with cleanup. Returns a `Disposable`.
 
 ```typescript
-import { addRequestAnimationFrameLoop } from 'jrx'
+import {makeAnimationFrameLoop} from 'jrx'
 
-const dispose = addRequestAnimationFrameLoop((now) => {
+const handle = makeAnimationFrameLoop((now) => {
   updateAnimation(now)
 
-  // Optional: return cleanup function
-  return () => {
-    cleanupAnimation()
+  // Optional: return a Disposable for cleanup
+  return {
+    [Symbol.dispose]() {
+      cleanupAnimation()
+    },
   }
 })
 
 // Stop the loop
-dispose()
+handle[Symbol.dispose]()
 ```
 
-### `addTimeout(cb, ms)`
+### `makeTimeout(cb, ms)`
 
-Creates a timeout with cleanup.
+Creates a timeout with cleanup. Returns a `Disposable`.
 
 ```typescript
-import { addTimeout } from 'jrx'
+import {makeTimeout} from 'jrx'
 
-const cancel = addTimeout(() => {
+const handle = makeTimeout(() => {
   console.log('Timeout fired')
 }, 1000)
 
 // Cancel if needed
-cancel()
+handle[Symbol.dispose]()
 ```
 
-### `addTransition(cb, durationMs)`
+### `makeTransition(cb, durationMs)`
 
-Creates an animation transition with progress tracking (0 to 1).
+Creates an animation transition with progress tracking (0 to 1). Returns a `Disposable`.
 
 ```typescript
-import { addTransition } from 'jrx'
+import {makeTransition} from 'jrx'
 
-const dispose = addTransition((progress) => {
+const handle = makeTransition((progress) => {
   element.style.opacity = progress.toString()
 
-  // Optional: return cleanup function
-  return () => {
-    console.log('Frame cleanup')
+  // Optional: return a Disposable for cleanup
+  return {
+    [Symbol.dispose]() {
+      console.log('Frame cleanup')
+    },
   }
 }, 1000)
 
-dispose()
+handle[Symbol.dispose]()
 ```
 
 ### `computed(fn, getDeps?)`
@@ -212,7 +222,7 @@ dispose()
 Creates a memoized computed value with optional dependency tracking.
 
 ```typescript
-import { computed } from 'jrx'
+import {computed} from 'jrx'
 
 // Without dependencies - always recomputes
 const value1 = computed(() => expensiveCalculation())
@@ -279,20 +289,22 @@ const data = await r // undefined
 
 ## Cleanup Pattern
 
-All effect functions return a dispose function that stops the effect and runs any pending cleanup:
+All effect functions return a `Disposable` object that stops the effect and runs any pending cleanup:
 
 ```typescript
-import {addInterval, addTimeout, addRequestAnimationFrame} from 'jrx'
-
-// Each function returns a dispose function
-const disposeInterval = addInterval(() => console.log('tick'), 1000)
-const disposeTimeout = addTimeout(() => console.log('timeout'), 5000)
-const disposeRaf = addRequestAnimationFrame((now) => render(now))
-
-// Call the dispose function to stop the effect
-disposeInterval()
-disposeTimeout()
-disposeRaf()
+import {makeInterval, makeTimeout, makeAnimationFrame, makeTransition} from 'jrx'
+
+// Each function returns a Disposable
+const interval = makeInterval(() => console.log('tick'), 1000)
+const timeout = makeTimeout(() => console.log('timeout'), 5000)
+const raf = makeAnimationFrame((now) => render(now))
+const transition = makeTransition((p) => console.log(p), 1000)
+
+// Call [Symbol.dispose]() to stop the effect
+interval[Symbol.dispose]()
+timeout[Symbol.dispose]()
+raf[Symbol.dispose]()
+transition[Symbol.dispose]()
 ```
 
 ## TypeScript

package/index.d.ts

@@ -5,11 +5,25 @@ export declare function makeReset(): () => DisposableStack;
 export declare function makeAsyncReset(): () => Promise<AsyncDisposableStack>;
 export declare function makeRenderLoop(): {
     loop(this: void, time: DOMHighResTimeStamp): void;
-    setLoop(this: void, loop: (time: DOMHighResTimeStamp) => undefined | (() => void)): () => void;
-};
-export declare function addInterval(cb: () => undefined | (() => any), ms: number): () => void;
-export declare function addIntervalAsync(cb: () => (void | Disposable) & (void | (() => any) | Promise<void> | Promise<() => any>), ms: number): () => void;
-export declare function addRequestAnimationFrame(cb: (now: DOMHighResTimeStamp) => undefined | (() => any)): () => void;
-export declare function addRequestAnimationFrameLoop(cb: (now: DOMHighResTimeStamp) => undefined | (() => any)): () => void;
-export declare function addTimeout(cb: () => void, ms: number): () => void;
-export declare function addTransition(cb: (progress: number) => undefined | (() => void), durationMs: number): () => void;
+    setLoop(this: void, loop: (time: DOMHighResTimeStamp) => undefined | Disposable): {
+        [Symbol.dispose](): void;
+    };
+};
+export declare function makeInterval(cb: () => undefined | Disposable, ms: number): {
+    [Symbol.dispose](): void;
+};
+export declare function makeIntervalAsync(cb: () => void | Disposable | Promise<void>, ms: number): {
+    [Symbol.dispose](): void;
+};
+export declare function makeAnimationFrame(cb: (now: DOMHighResTimeStamp) => undefined | Disposable): {
+    [Symbol.dispose](): void;
+};
+export declare function makeAnimationFrameLoop(cb: (now: DOMHighResTimeStamp) => undefined | Disposable): {
+    [Symbol.dispose](): void;
+};
+export declare function makeTimeout(cb: () => void, ms: number): {
+    [Symbol.dispose](): void;
+};
+export declare function makeTransition(cb: (progress: number) => undefined | Disposable, durationMs: number): {
+    [Symbol.dispose](): void;
+};

package/index.js

@@ -20,93 +20,109 @@ export function makeRenderLoop() {
     const reset = makeReset();
     return {
         loop(time) {
-            reset().adopt(loop_?.(time), v => v?.());
+            reset().use(loop_?.(time));
         },
         setLoop(loop) {
             loop_ = loop;
-            return () => {
-                reset();
-                loop_ = undefined;
+            return {
+                [Symbol.dispose]() {
+                    reset();
+                    loop_ = undefined;
+                },
             };
         },
     };
 }
-export function addInterval(cb, ms) {
+export function makeInterval(cb, ms) {
     const reset = makeReset();
     let timeout;
     wrapper();
-    return () => {
-        reset();
-        clearTimeout(timeout);
+    return {
+        [Symbol.dispose]() {
+            reset();
+            clearTimeout(timeout);
+        },
     };
     function wrapper() {
-        reset().adopt(cb(), v => v?.());
+        reset().use(cb());
         timeout = setTimeout(wrapper, ms);
     }
 }
-export function addIntervalAsync(cb, ms) {
+export function makeIntervalAsync(cb, ms) {
     const reset = makeReset();
     let timeout;
     void wrapper();
-    return () => {
-        reset();
-        clearTimeout(timeout);
+    return {
+        [Symbol.dispose]() {
+            reset();
+            clearTimeout(timeout);
+        },
     };
     async function wrapper() {
         const stack = reset();
-        await stack.adopt(cb(), v => v?.[Symbol.dispose]?.());
+        await stack.adopt(cb(), (v) => v?.[Symbol.dispose]?.());
         if (!stack.disposed)
             timeout = setTimeout(wrapper, ms);
     }
 }
-export function addRequestAnimationFrame(cb) {
+export function makeAnimationFrame(cb) {
     const stack = new DisposableStack();
     const raf = requestAnimationFrame(now => {
         if (stack.disposed)
             return;
-        stack.adopt(cb(now), v => v?.());
+        stack.use(cb(now));
     });
-    return () => {
-        stack.dispose();
-        cancelAnimationFrame(raf);
+    return {
+        [Symbol.dispose]() {
+            stack.dispose();
+            cancelAnimationFrame(raf);
+        },
     };
 }
-export function addRequestAnimationFrameLoop(cb) {
+export function makeAnimationFrameLoop(cb) {
     const reset = makeReset();
     let raf = requestAnimationFrame(wrapper);
-    return () => {
-        reset();
-        cancelAnimationFrame(raf);
+    return {
+        [Symbol.dispose]() {
+            reset();
+            cancelAnimationFrame(raf);
+        },
     };
     function wrapper(now) {
-        reset().adopt(cb(now), v => v?.());
+        reset().use(cb(now));
         raf = requestAnimationFrame(wrapper);
     }
 }
-export function addTimeout(cb, ms) {
+export function makeTimeout(cb, ms) {
     const timeout = setTimeout(cb, ms);
-    return () => clearTimeout(timeout);
+    return {
+        [Symbol.dispose]() {
+            clearTimeout(timeout);
+        },
+    };
 }
-export function addTransition(cb, durationMs) {
+export function makeTransition(cb, durationMs) {
     const reset = makeReset();
     let start;
     let raf = requestAnimationFrame(wrapper);
-    return () => {
-        reset();
-        cancelAnimationFrame(raf);
+    return {
+        [Symbol.dispose]() {
+            reset();
+            cancelAnimationFrame(raf);
+        },
     };
     function wrapper(now) {
         if (start === undefined) {
             start = now;
-            reset().adopt(cb(0), v => v?.());
+            reset().use(cb(0));
             raf = requestAnimationFrame(wrapper);
         }
         else {
             const progress = (now - start) / durationMs;
             if (progress >= 1)
-                reset().adopt(cb(1), v => v?.());
+                reset().use(cb(1));
             else {
-                reset().adopt(cb(progress), v => v?.());
+                reset().use(cb(progress));
                 raf = requestAnimationFrame(wrapper);
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "jrx",
-	"version": "0.3.0-alpha.1",
+	"version": "0.3.0-alpha.3",
 	"type": "module",
 	"scripts": {
 		"prepublishOnly": "npx tsc",