@webreflection/signals 0.1.1 → 0.1.3

package/README.md

@@ -4,7 +4,7 @@
 
 [![Coverage Status](https://coveralls.io/repos/github/WebReflection/signals/badge.svg?branch=main)](https://coveralls.io/github/WebReflection/signals?branch=main)
 
-A minimalistic [Preact-like signals](https://preactjs.com/guide/v10/signals/) (*minus options*) implementation.
+A minimalistic [Preact-like signals](https://github.com/preactjs/signals/blob/main/packages/core/README.md) implementation.
 
 Once minified and compressed, this module is actually [0.5KB](https://cdn.jsdelivr.net/npm/@webreflection/signals/dist/signals.js).
 
@@ -13,9 +13,9 @@ Once minified and compressed, this module is actually [0.5KB](https://cdn.jsdeli
 // basic core features
 import {
   batch,      // Preact-like API
-  computed,   // Preact-like API w/out options
-  effect,     // Preact-like API w/out options
-  signal,     // Preact-like API w/out options
+  computed,   // Preact-like API
+  effect,     // Preact-like API
+  signal,     // Preact-like API
   untracked,  // Preact-like API
 } from '@webreflection/signals';
 ```
@@ -72,13 +72,23 @@ import {
 
 You know, nowadays it's hard to find libraries that are still 100% under control, minimalistic, not bloated, yet correct, and this one would like to be one of those 😇
 
+
 #### The Beauty
 
   * [signal](https://github.com/WebReflection/signals/blob/main/src/signal.js) is 26 LOC.
   * [computed](https://github.com/WebReflection/signals/blob/main/src/computed.js) is 33 LOC.
   * the shared [stack](https://github.com/WebReflection/signals/blob/main/src/stack.js) is 20 LOC.
   * [effect](https://github.com/WebReflection/signals/blob/main/src/effect.js) is where business happens, 75 LOC.
-  * [disposable](https://github.com/WebReflection/signals/blob/main/src/disposable.js) is 12 LOC, based on the core library mentioned in the previous points.
-  * [branded](https://github.com/WebReflection/signals/blob/main/src/branded.js) is 21 LOC extra needed only for libraries building on top.
+  * [disposable](https://github.com/WebReflection/signals/blob/main/src/disposable.js) is 10 LOC, based on the core library mentioned in the previous points.
+  * [branded](https://github.com/WebReflection/signals/blob/main/src/branded.js) is 25 LOC extra needed only for libraries building on top.
 
 I mean ... that's coding, isn't it ... today I really needed something that would remind me why I love what I do ❤️
+
+
+#### Benchmark
+
+![benchmark](/WebReflection/usignal/raw/main/test/benchmark.png)
+
+There is a *huge* difference between *NodeJS* and *Bun* but that's likely because *JSC* handles *Set* or *Map* in a better way, meaning all *WebKit* based browsers and mobile devices will have similar *Preact* performance, while *Chromium* based browsers will have half Preact size, but 1.5X slowdown.
+
+However, in common scenarios with no more than 10 to 100 signals per *effect*, the performance are consistently better or really close to Preact.

package/dist/branded.js

@@ -1 +1 @@
-var l=!0,d=t=>{l=t},i=()=>l,n=null,f=t=>{l&&n&&t.add(n)},a=(t,e)=>{let r=n;n=t;try{return e()}finally{n=r}};var u=new WeakSet,c=new WeakMap,g=[],p=!1,M=t=>{let e=!p;e&&(p=!0);try{return t()}finally{if(e){p=!1;for(let[r,o]of g.splice(0))u.has(r)||o()}}},h=t=>{let e=c.get(t);if(e.length)for(let o of e.splice(0))x(o)},x=t=>{u.add(t),h(t),c.delete(t)},k=t=>{let e=()=>{o||u.has(e)||(o=!0,n||(p?g.push([e,r]):r()))},r=()=>{for(;o;)if(o=!1,h(e),s?.(),s=a(e,t),u.has(e))return},o=!0,s;return n&&c.get(n).push(e),c.set(e,[]),r(),()=>{c.has(e)&&(s?.(),x(e))}};var w=t=>{let e=new Set,r=!0,o,s=()=>{if(r)return;r=!0;let S=e;e=new Set;for(let v of S)v()},b=()=>{for(;r;)r=!1,o=a(s,t);return o};return{get value(){return f(e),b()},peek(){return b()}}};var y=t=>{let e=new Set;return{get value(){return f(e),t},set value(r){if(t=r,i()){let o=e;e=new Set;for(let s of o)s()}},peek(){return t}}};var B=t=>{let e=i();d(!1);try{return t()}finally{d(e)}};var{defineProperty:T}=Object,{dispose:W}=Symbol,J=t=>function(...r){let o,s=k(()=>{o??=t.apply(this,r)??this});return T(o,W,{value:s})};var m=new WeakSet,R=t=>{let e=w(t);return m.add(e),e},V=t=>m.has(t),X=t=>{let e=y(t);return m.add(e),e};export{M as batch,R as computed,J as disposable,k as effect,V as isSignal,X as signal,B as untracked};
+var l=!0,m=t=>{l=t},f=()=>l,n=null,i=t=>{l&&n&&t.add(n)},a=(t,e)=>{let r=n;n=t;try{return e()}finally{n=r}};var u=new WeakSet,c=new WeakMap,x=[],p=!1,$=t=>{let e=!p;e&&(p=!0);try{return t()}finally{if(e){p=!1;for(let[r,o]of x.splice(0))u.has(r)||o()}}},g=t=>{let e=c.get(t);if(e.length)for(let o of e.splice(0))h(o)},h=t=>{u.add(t),g(t),c.delete(t)},k=t=>{let e=()=>{o||u.has(e)||(o=!0,n||(p?x.push([e,r]):r()))},r=()=>{for(;o;)if(o=!1,g(e),s?.(),s=a(e,t),u.has(e))return},o=!0,s;return n&&c.get(n).push(e),c.set(e,[]),r(),()=>{c.has(e)&&(s?.(),h(e))}};var w=t=>{let e=new Set,r=!0,o,s=()=>{if(r)return;r=!0;let S=e;e=new Set;for(let v of S)v()},b=()=>{for(;r;)r=!1,o=a(s,t);return o};return{get value(){return i(e),b()},peek(){return b()}}};var y=t=>{let e=new Set;return{get value(){return i(e),t},set value(r){if(t=r,f()){let o=e;e=new Set;for(let s of o)s()}},peek(){return t}}};var B=t=>{let e=f();m(!1);try{return t()}finally{m(e)}};var J=t=>function(...r){let o,s=k(()=>{o??=t.apply(this,r)??this});return o[Symbol.dispose]=s,o};var d=new WeakSet,P=t=>{let e=w(t);return d.add(e),e},Q=t=>d.has(t),R=t=>{let e=y(t);return d.add(e),e};export{$ as batch,P as computed,J as disposable,k as effect,Q as isSignal,R as signal,B as untracked};

package/dist/disposable.js

@@ -1 +1 @@
-var p=!0,b=t=>{p=t},f=()=>p,n=null,i=t=>{p&&n&&t.add(n)},u=(t,e)=>{let r=n;n=t;try{return e()}finally{n=r}};var a=new WeakSet,c=new WeakMap,d=[],l=!1,W=t=>{let e=!l;e&&(l=!0);try{return t()}finally{if(e){l=!1;for(let[r,o]of d.splice(0))a.has(r)||o()}}},m=t=>{let e=c.get(t);if(e.length)for(let o of e.splice(0))g(o)},g=t=>{a.add(t),m(t),c.delete(t)},x=t=>{let e=()=>{o||a.has(e)||(o=!0,n||(l?d.push([e,r]):r()))},r=()=>{for(;o;)if(o=!1,m(e),s?.(),s=u(e,t),a.has(e))return},o=!0,s;return n&&c.get(n).push(e),c.set(e,[]),r(),()=>{c.has(e)&&(s?.(),g(e))}};var O=t=>{let e=new Set,r=!0,o,s=()=>{if(r)return;r=!0;let k=e;e=new Set;for(let y of k)y()},h=()=>{for(;r;)r=!1,o=u(s,t);return o};return{get value(){return i(e),h()},peek(){return h()}}};var q=t=>{let e=new Set;return{get value(){return i(e),t},set value(r){if(t=r,f()){let o=e;e=new Set;for(let s of o)s()}},peek(){return t}}};var B=t=>{let e=f();b(!1);try{return t()}finally{b(e)}};var{defineProperty:w}=Object,{dispose:v}=Symbol,J=t=>function(...r){let o,s=x(()=>{o??=t.apply(this,r)??this});return w(o,v,{value:s})};export{W as batch,O as computed,J as disposable,x as effect,q as signal,B as untracked};
+var p=!0,b=t=>{p=t},f=()=>p,n=null,i=t=>{p&&n&&t.add(n)},u=(t,e)=>{let r=n;n=t;try{return e()}finally{n=r}};var a=new WeakSet,c=new WeakMap,m=[],l=!1,S=t=>{let e=!l;e&&(l=!0);try{return t()}finally{if(e){l=!1;for(let[r,o]of m.splice(0))a.has(r)||o()}}},d=t=>{let e=c.get(t);if(e.length)for(let o of e.splice(0))g(o)},g=t=>{a.add(t),d(t),c.delete(t)},x=t=>{let e=()=>{o||a.has(e)||(o=!0,n||(l?m.push([e,r]):r()))},r=()=>{for(;o;)if(o=!1,d(e),s?.(),s=u(e,t),a.has(e))return},o=!0,s;return n&&c.get(n).push(e),c.set(e,[]),r(),()=>{c.has(e)&&(s?.(),g(e))}};var M=t=>{let e=new Set,r=!0,o,s=()=>{if(r)return;r=!0;let k=e;e=new Set;for(let w of k)w()},h=()=>{for(;r;)r=!1,o=u(s,t);return o};return{get value(){return i(e),h()},peek(){return h()}}};var q=t=>{let e=new Set;return{get value(){return i(e),t},set value(r){if(t=r,f()){let o=e;e=new Set;for(let s of o)s()}},peek(){return t}}};var B=t=>{let e=f();b(!1);try{return t()}finally{b(e)}};var J=t=>function(...r){let o,s=x(()=>{o??=t.apply(this,r)??this});return o[Symbol.dispose]=s,o};export{S as batch,M as computed,J as disposable,x as effect,q as signal,B as untracked};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webreflection/signals",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "A minimalistic Preact-like signals implementation",
   "main": "src/index.js",
   "module": "src/index.js",

package/src/branded.js

@@ -1,21 +1,25 @@
-export * from './effect.js';
 export * from './disposable.js';
+export * from './effect.js';
+export * from './untracked.js';
 
 import { computed as $computed } from './computed.js';
 import { signal as $signal } from './signal.js';
 
 const branded = new WeakSet;
 
-export const computed = callback => {
-  const computed = $computed(callback);
+/** @type {<T>(fn: () => T) => { readonly value: T, peek: () => T }} */
+export const computed = fn => {
+  const computed = $computed(fn);
   branded.add(computed);
   return computed;
 };
 
+/** @type {(value: unknown) => boolean} */
 export const isSignal = value => branded.has(value);
 
-export const signal = current => {
-  const signal = $signal(current);
+/** @type {<T>(init: T) => { value: T, peek: () => T }} */
+export const signal = init => {
+  const signal = $signal(init);
   branded.add(signal);
   return signal;
 };

package/src/disposable.js

@@ -1,12 +1,10 @@
 export * from './index.js';
 import { effect } from './effect.js';
 
-const { defineProperty } = Object;
-const { dispose } = Symbol;
-
-export const disposable = callback => function disposable(...args) {
+export const disposable = fn => function disposable(...args) {
   let ref, value = effect(() => {
-    ref ??= callback.apply(this, args) ?? this;
+    ref ??= fn.apply(this, args) ?? this;
   });
-  return defineProperty(ref, dispose, { value });
+  ref[Symbol.dispose] = value;
+  return ref;
 };

package/types/branded.d.ts

@@ -1,11 +1,15 @@
-export * from "./effect.js";
 export * from "./disposable.js";
-export function computed(callback: any): {
-    readonly value: any;
-    peek: () => any;
+export * from "./effect.js";
+export * from "./untracked.js";
+/** @type {<T>(fn: () => T) => { readonly value: T, peek: () => T }} */
+export const computed: <T>(fn: () => T) => {
+    readonly value: T;
+    peek: () => T;
 };
-export function isSignal(value: any): boolean;
-export function signal(current: any): {
-    value: any;
-    peek: () => any;
+/** @type {(value: unknown) => boolean} */
+export const isSignal: (value: unknown) => boolean;
+/** @type {<T>(init: T) => { value: T, peek: () => T }} */
+export const signal: <T>(init: T) => {
+    value: T;
+    peek: () => T;
 };

package/types/disposable.d.ts

@@ -1,2 +1,2 @@
 export * from "./index.js";
-export function disposable(callback: any): (...args: any[]) => undefined;
+export function disposable(fn: any): (...args: any[]) => undefined;