@xaendar/signals 0.4.6 → 0.4.10

package/dist/xaendar-signals.es.d.ts

@@ -193,6 +193,7 @@ declare global {
 export { };
 
 import { NoArgsVoidFunction } from '@xaendar/types';
+import { NoArgsVoidFunction as NoArgsVoidFunction_2 } from '@xaendar/types';
 
 /**
  * A read-only Signal whose value is derived lazily from other Signals.
@@ -297,7 +298,26 @@ declare type ComputedState = 'dirty' | 'checked' | 'computing' | 'clean';
  *   is tracked as a dependency.
  * @returns A disposer function that, when called, permanently stops the effect.
  */
-export declare function effect(fn: NoArgsVoidFunction): NoArgsVoidFunction;
+export declare function effect(fn: NoArgsVoidFunction, options?: EffectOptions): NoArgsVoidFunction;
+
+/**
+ * Options for configuring an effect.
+ */
+export declare type EffectOptions = {
+    /**
+     * Registers a cleanup function that is called before the effect re-runs or when it is disposed.
+     * @param cleanupFn - The function to invoke during cleanup.
+     */
+    onCleanup?: NoArgsVoidFunction_2;
+    /**
+     * Called before the effect re-runs.
+     */
+    onBeforeRun?: () => void;
+    /**
+     * Called after the effect re-runs.
+     */
+    onAfterRun?: () => void;
+};
 
 /**
  * Utility type to extract the inner type of a Signal.State.

package/dist/xaendar-signals.es.js

@@ -967,7 +967,7 @@ function loadSignals(options) {
 *   is tracked as a dependency.
 * @returns A disposer function that, when called, permanently stops the effect.
 */
-function effect(fn) {
+function effect(fn, options) {
 	/**
 	* Wrap the user callback in a Computed so that automatic dependency
 	* tracking (via pushComputed / popComputed) works for free.
@@ -987,13 +987,17 @@ function effect(fn) {
 			needsEnqueue = false;
 			queueMicrotask(() => {
 				needsEnqueue = true;
+				options?.onBeforeRun?.();
 				watcher.getPending().forEach((computed) => computed.get());
+				options?.onAfterRun?.();
 				watcher.watch();
 			});
 		}
 	});
+	options?.onBeforeRun?.();
 	watcher.watch(computed);
 	computed.get();
+	options?.onAfterRun?.();
 	/**
 	* Disposer — call this to permanently stop the effect.
 	*
@@ -1001,7 +1005,10 @@ function effect(fn) {
 	* (Watcher → Computed → all sources), preventing any further
 	* notifications and allowing GC.
 	*/
-	return () => watcher.unwatch(computed);
+	return () => {
+		options?.onCleanup?.();
+		watcher.unwatch(computed);
+	};
 }
 //#endregion
 export { effect, loadSignals };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xaendar/signals",
-  "version": "0.4.6",
+  "version": "0.4.10",
   "description": "A library implementing a reactive system for Xaendar framework. This signal implementation is based on the TC39 Stage1 proposal for reactive primitives.",
   "sideEffects": false,
   "type": "module",
@@ -16,7 +16,7 @@
     }
   },
   "dependencies": {
-    "@xaendar/common": "0.4.6",
-    "@xaendar/types": "0.4.6"
+    "@xaendar/common": "0.4.10",
+    "@xaendar/types": "0.4.10"
   }
 }