@silvery/signals 0.29.0 → 0.29.3

package/dist/index.d.mts

@@ -1,5 +1,17 @@
+/**
+ * @silvery/signals — Reactive signals for silvery.
+ *
+ * Thin wrapper around alien-signals providing:
+ * - signal(value) — create a reactive value (call to read, call with arg to write)
+ * - computed(fn) — derived reactive value that recomputes on dependency changes
+ * - effect(fn) — side effect that re-runs when dependencies change
+ * - effectScope(fn) — group effects for collective disposal
+ * - batch(fn) — batch multiple signal updates into one notification
+ * - watch(read, onChange) — change-only subscription (skips the seed fire)
+ *
+ * @packageDocumentation
+ */
 import { computed, effect, effectScope, endBatch, getActiveSub, getBatchDepth, isComputed, isEffect, isEffectScope, isSignal, setActiveSub, signal, startBatch, trigger } from "alien-signals";
-//#region src/index.d.ts
 /**
  * A reactive value — callable getter/setter.
  *
@@ -9,7 +21,7 @@ import { computed, effect, effectScope, endBatch, getActiveSub, getBatchDepth, i
  * Matches the return shape of `signal<T>(initial)` from alien-signals, so any
  * `signal()` result is assignable to `Signal<T>`.
  */
-type Signal<T> = {
+export type Signal<T> = {
   (): T;
   (value: T): void;
 };
@@ -18,13 +30,13 @@ type Signal<T> = {
  * effect/computed but cannot be written to. Matches the return shape of
  * `computed<T>(fn)` from alien-signals.
  */
-type ReadSignal<T> = () => T;
+export type ReadSignal<T> = () => T;
 /** Batch multiple signal updates, notifying subscribers once at the end. */
-declare function batch(fn: () => void): void;
+export declare function batch(fn: () => void): void;
 /**
  * Options for {@link watch}.
  */
-interface WatchOptions<T> {
+export interface WatchOptions<T> {
   /** If true, fire `onChange` on the seed read with `(next, next)`. Default false (change-only). */
   immediate?: boolean;
   /** Equality predicate — handler fires only when `equals(next, prev)` is false. Default `Object.is`. */
@@ -49,7 +61,6 @@ interface WatchOptions<T> {
  *
  * Returns the effect's stop function.
  */
-declare function watch<T>(read: () => T, onChange: (next: T, prev: T) => void, opts?: WatchOptions<T>): () => void;
-//#endregion
-export { ReadSignal, Signal, WatchOptions, batch, computed, effect, effectScope, endBatch, getActiveSub, getBatchDepth, isComputed, isEffect, isEffectScope, isSignal, setActiveSub, signal, startBatch, trigger, watch };
+export declare function watch<T>(read: () => T, onChange: (next: T, prev: T) => void, opts?: WatchOptions<T>): () => void;
+export { computed, effect, effectScope, endBatch, getActiveSub, getBatchDepth, isComputed, isEffect, isEffectScope, isSignal, setActiveSub, signal, startBatch, trigger };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;;KA0CY,OAAO;MACb;GACH,OAAO;;;;;;;KAQE,WAAW,WAAW;;iBAGlB,MAAM;;;;UAYL,aAAa;;EAE5B;;EAEA,UAAU,GAAG,GAAG,GAAG;;;;;;;;;;;;;;;;;;;;;iBAsBL,MAAM,GACpB,YAAY,GACZ,WAAW,MAAM,GAAG,MAAM,YAC1B,OAAM,aAAa"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;YA0CY,OAAO;MACb;GACH,OAAO;;;;;;;YAQE,WAAW,WAAW;;wBAGlB,MAAM;;;;iBAYL,aAAa;;EAE5B;;EAEA,UAAU,GAAG,GAAG,GAAG;;;;;;;;;;;;;;;;;;;;;wBAsBL,MAAM,GACpB,YAAY,GACZ,WAAW,MAAM,GAAG,MAAM,YAC1B,OAAM,aAAa"}

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { computed, effect, effect as effect$1, effectScope, endBatch, endBatch as endBatch$1, getActiveSub, getBatchDepth, isComputed, isEffect, isEffectScope, isSignal, setActiveSub, signal, startBatch, startBatch as startBatch$1, trigger } from "alien-signals";
-//#region src/index.ts
+// src/index.ts
 /** Batch multiple signal updates, notifying subscribers once at the end. */
 function batch(fn) {
 	startBatch$1();
@@ -46,7 +46,6 @@ function watch(read, onChange, opts = {}) {
 		onChange(next, old);
 	});
 }
-//#endregion
 export { batch, computed, effect, effectScope, endBatch, getActiveSub, getBatchDepth, isComputed, isEffect, isEffectScope, isSignal, setActiveSub, signal, startBatch, trigger, watch };
 
 //# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@silvery/signals",
-  "version": "0.29.0",
+  "version": "0.29.3",
   "description": "Reactive signals for silvery — thin wrapper around alien-signals",
   "license": "MIT",
   "author": "Bjørn Stabell <bjorn@stabell.org>",