fix: untrack - infer return type

.changeset/soft-rats-love.md

@@ -0,0 +1,5 @@
+---
+'@kaiverse/signal': patch
+---
+
+fix `unTrack` infer return type

README.md

@@ -5,7 +5,7 @@
 <div align="center">
 <h1>Signal Proxy</h1>
 
-<p>A simple reactive system for your Javascript application.<br/>Zero dependency, TypeScript fully supported.</p>
+<p>A lightweight, simple reactive system for your Javascript application.<br/>Zero dependencies, TypeScript fully supported.</p>
 </div>
 
 This package draws strong inspiration from [KnockoutJS](https://github.com/knockout/knockout)'s concepts and [SolidJS](https://github.com/solidjs)'s Signal, enabling us to use Signals in vanilla JavaScript. [JS Signals proposal](https://github.com/tc39/proposal-signals) is currently in Stage 1.

packages/signal/README.md

@@ -3,7 +3,7 @@
 <div align="center">
 <h1>Signal Proxy</h1>
 
-<p>A simple reactive system for your Javascript application.<br/>Zero dependency, TypeScript fully supported.</p>
+<p>A lightweight, simple reactive system for your Javascript application.<br/>Zero dependencies, TypeScript fully supported.</p>
 </div>
 
 This package draws strong inspiration from [KnockoutJS](https://github.com/knockout/knockout)'s concepts and [SolidJS](https://github.com/solidjs)'s Signal, enabling us to use Signals in vanilla JavaScript. [JS Signals proposal](https://github.com/tc39/proposal-signals) is currently in Stage 1.

packages/signal/jsr.json

@@ -1,6 +1,6 @@
 {
     "name": "@kaiverse/signal",
-    "version": "0.2.2",
+    "version": "0.2.3",
     "exports": "./src/index.ts",
     "publish": {
         "exclude": [

packages/signal/src/types.ts

@@ -40,3 +40,4 @@ export type SignalFactoryReturnType<T> = Readonly<[get: Signal<T>, set: SignalSe
 export type SignalEffect = () => void;
 export type EffectTracking = {execute: SignalEffect; deps: Set<Set<EffectTracking>>};
 export type CleanupEffectFn = () => void;
+export type SignalUntrackFn<T> = () => T;

packages/signal/src/utils.ts

@@ -9,21 +9,23 @@ import type {
   SignalOptions,
   SignalSetter,
   CleanupEffectFn,
+  SignalUntrackFn,
 } from './types';
 
 let effectTrackingCache: EffectTracking | null = null;
 
 /**
- * Ignores tracking any of the dependencies in the `untrackEffectCb` and returns its value
+ * Ignores tracking any of the dependencies inside the `untrackFn` scope.
  *
- * @param untrackEffectCb
+ * @param untrackFn the executing code block.
+ * @returns the return value of `untrackFn`.
  */
-export function unTrack(untrackEffectCb: SignalEffect): void {
+export function unTrack<T>(untrackFn: SignalUntrackFn<T>): T {
   const prevEffectTracking = effectTrackingCache;
   effectTrackingCache = null;
-  const untrackEffectExecute = untrackEffectCb();
+  const untrackReturnValue = untrackFn();
   effectTrackingCache = prevEffectTracking;
-  return untrackEffectExecute;
+  return untrackReturnValue;
 }
 
 /**
@@ -84,7 +86,7 @@ export function createSignal<T>(
 }
 
 /**
- * @param effectCb Imperative function that will run whenever dependencies change. Dependencies are Signals that are used inside the Effect itself
+ * @param effect Imperative function that will run whenever dependencies change. Dependencies are Signals that are used inside the Effect itself.
  * @returns a cleanup function. It will stop related Effect.
  */
 export function createEffect(effect: SignalEffect): CleanupEffectFn {
@@ -98,6 +100,7 @@ export function createEffect(effect: SignalEffect): CleanupEffectFn {
     deps: new Set(),
   };
 
+  // const weakEffectDetailRef = new WeakRef(effectDetail);
   effectDetail.execute();
 
   // if (import.meta.hot) {
@@ -110,7 +113,7 @@ export function createEffect(effect: SignalEffect): CleanupEffectFn {
 }
 
 /**
- * `createComputed` creates a readonly reactive value equal to the return value of the given function and this function only gets executed when its dependencies change.
+ * Creates a readonly reactive value equal to the return value of the given function and this function only gets executed when its dependencies change.
  *
  * Dependencies are all Signals that are used inside the Computed function.
  *