@tinyfx/runtime 0.1.8 → 0.1.9

package/dist/signals.js

@@ -1,6 +1,19 @@
 // @tinyfx/runtime — signals
 // Minimal, explicit reactivity — no proxies, no magic.
 const effectStack = [];
+/**
+ * Reactive value container used by TinyFX signals.
+ *
+ * Reading the value through {@link Signal.get} during an active effect records
+ * that effect as a subscriber. Writing through {@link Signal.set} re-runs the
+ * affected subscribers.
+ *
+ * @example
+ * const count = new Signal(0);
+ * console.log(count.get());
+ * count.set(1);
+ * console.log(count.get());
+ */
 export class Signal {
     constructor(v) {
         this.subs = new Set();
@@ -20,12 +33,40 @@ export class Signal {
         this.subs.forEach((fn) => fn());
     }
 }
+/**
+ * Creates a reactive signal function.
+ *
+ * @param v - The initial value stored by the signal
+ * @returns A callable signal that reads the current value and exposes `.set()`
+ *          to update it
+ *
+ * @example
+ * const count = signal(0);
+ * console.log(count());
+ * count.set(1);
+ */
 export function signal(v) {
     const s = new Signal(v);
     const fn = () => s.get();
     fn.set = (v) => s.set(v);
     return fn;
 }
+/**
+ * Registers and runs a reactive effect.
+ *
+ * Every signal read while `fn` runs is tracked, and the effect is re-run when
+ * any of those signal values change.
+ *
+ * @param fn - The reactive callback to execute and subscribe
+ * @returns Nothing
+ *
+ * @example
+ * const count = signal(0);
+ * effect(() => {
+ *   console.log(`count = ${count()}`);
+ * });
+ * count.set(1);
+ */
 export function effect(fn) {
     const run = () => {
         effectStack.push(run);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinyfx/runtime",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Minimal frontend runtime — signals, DOM helpers, typed HTTP, DTO mapping",
   "type": "module",
   "main": "./dist/index.js",
@@ -17,10 +17,14 @@
   ],
   "scripts": {
     "build": "tsc",
+    "test": "vitest run",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "typescript": "^5.9.3"
+    "@vitest/coverage-v8": "^4.1.2",
+    "jsdom": "^29.0.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.2"
   },
   "license": "MIT"
 }