@nerdalytics/beacon 1000.1.1 → 1000.2.0

package/README.md

@@ -1,28 +1,50 @@
 # Beacon <img align="right" src="https://raw.githubusercontent.com/nerdalytics/beacon/refs/heads/trunk/assets/beacon-logo.svg" width="128px" alt="A stylized lighthouse beacon with golden light against a dark blue background, representing the reactive state library"/>
 
+> Lightweight reactive state management for Node.js backends
+
+[![license:mit](https://flat.badgen.net/static/license/MIT/blue)](https://github.com/nerdalytics/beacon/blob/trunk/LICENSE)
+[![registry:npm:version](https://img.shields.io/npm/v/@nerdalytics/beacon.svg)](https://www.npmjs.com/package/@nerdalytics/beacon)
+
+[![tech:nodejs](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://nodejs.org/)
+[![language:typescript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)](https://typescriptlang.org/)
+[![linter:biome](https://img.shields.io/badge/biome-60a5fa?style=for-the-badge&logo=biome&logoColor=white)](https://biomejs.dev/)
+
 A lightweight reactive state library for Node.js backends. Enables reactive state management with automatic dependency tracking and efficient updates for server-side applications.
 
-## Table of Contents
+<details>
+<summary><Strong>Table of Contents</Strong></summary>
 
 - [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-- [API](#api)
-  - [state](#statetinitialvalue-t-statet)
-  - [derive](#derivetfn---t-readonlystatet)
-  - [effect](#effectfn---void---void)
-  - [batch](#batchtfn---t-t)
-  - [select](#selectt-rsource-readonlystatet-selectorfn-state-t--r-equalityfn-a-r-b-r--boolean-readonlystater)
-  - [lens](#lenst-ksource-statet-accessor-state-t--k-statek)
-  - [readonlyState](#readonlystatetstate-statet-readonlystatet)
-  - [protectedState](#protectedstatetinitialvalue-t-readonlystatet-writeablestatet)
+- [Quick Start](#quick-start)
+- [Core Concepts](#core-concepts)
+- [API Reference](#api-reference)
+   - [Core Primitives](#core-primitives)
+      - [state](#statetinitialvalue-t-equalityfn-a-t-b-t--boolean-statet)
+      - [derive](#derivetfn---t-readonlystatet)
+      - [effect](#effectfn---void---void)
+      - [batch](#batchtfn---t-t)
+      - [select](#selectt-rsource-readonlystatet-selectorfn-state-t--r-equalityfn-a-r-b-r--boolean-readonlystater)
+      - [lens](#lenst-ksource-statet-accessor-state-t--k-statek)
+   - [Access Control](#access-control)
+      - [readonlyState](#readonlystatetstate-statet-readonlystatet)
+      - [protectedState](#protectedstatetinitialvalue-t-equalityfn-a-t-b-t--boolean-readonlystatet-writeablestatet)
+- [Advanced Features](#advanced-features)
+   - [Infinite Loop Protection](#infinite-loop-protection)
+   - [Automatic Cleanup](#automatic-cleanup)
+   - [Custom Equality Functions](#custom-equality-functions)
+- [Design Philosophy](#design-philosophy)
+- [Architecture](#architecture)
 - [Development](#development)
-  - [Node.js LTS Compatibility](#nodejs-lts-compatibility)
-- [Key Differences vs TC39 Proposal](#key-differences-between-my-library-and-the-tc39-proposal)
-- [Implementation Details](#implementation-details)
+- [Key Differences vs TC39 Proposal](#key-differences-vs-tc39-proposal)
 - [FAQ](#faq)
+   - [Why "Beacon" Instead of "Signal"?](#why-beacon-instead-of-signal)
+   - [How does Beacon handle memory management?](#how-does-beacon-handle-memory-management)
+   - [Can I use Beacon with Express or other frameworks?](#can-i-use-beacon-with-express-or-other-frameworks)
+   - [Can Beacon be used in browser applications?](#can-beacon-be-used-in-browser-applications)
 - [License](#license)
 
+</details>
+
 ## Features
 
 - 📶 **Reactive state** - Create reactive values that automatically track dependencies
@@ -35,67 +57,209 @@ A lightweight reactive state library for Node.js backends. Enables reactive stat
 - ♻️ **Cycle handling** - Safely manages cyclic dependencies without crashing
 - 🚨 **Infinite loop detection** - Automatically detects and prevents infinite update loops
 - 🛠️ **TypeScript-first** - Full TypeScript support with generics
-- 🪶 **Lightweight** - Zero dependencies, < 200 LOC
+- 🪶 **Lightweight** - Zero dependencies
 - ✅ **Node.js compatibility** - Works with Node.js LTS v20+ and v22+
 
-## Installation
+## Quick Start
 
-```sh
-npm install @nerdalytics/beacon
+```other
+npm install @nerdalytics/beacon --save-exact
 ```
 
-## Usage
-
 ```typescript
-import { state, derive, effect, batch, select, readonlyState, protectedState } from "@nerdalytics/beacon";
+import { state, derive, effect } from '@nerdalytics/beacon';
 
 // Create reactive state
 const count = state(0);
-const doubled = derive(() => count() * 2);
 
-// Read values
-console.log(count()); // => 0
-console.log(doubled()); // => 0
+// Create a derived value
+const doubled = derive(() => count() * 2);
 
-// Setup an effect that automatically runs when dependencies change
-// effect() returns a cleanup function that removes all subscriptions when called
-const unsubscribe = effect(() => {
-  console.log(`Count is ${count()}, doubled is ${doubled()}`);
+// Set up an effect
+effect(() => {
+  console.log(`Count: ${count()}, Doubled: ${doubled()}`);
 });
-// => "Count is 0, doubled is 0" (effect runs immediately when created)
+// => "Count: 0, Doubled: 0"
 
-// Update values - effect automatically runs after each change
+// Update the state - effect runs automatically
 count.set(5);
-// => "Count is 5, doubled is 10"
+// => "Count: 5, Doubled: 10"
+```
+
+## Core Concepts
+
+Beacon is built around three core primitives:
+
+1. **States**: Mutable, reactive values
+2. **Derived States**: Read-only computed values that update automatically
+3. **Effects**: Side effects that run automatically when dependencies change
+
+The library handles all the dependency tracking and updates automatically, so you can focus on your business logic.
+
+## API Reference
+
+### Version Compatibility
+
+The table below tracks when features were introduced and when function signatures were changed.
+
+| API | Introduced | Last Updated | Notes |
+|-----|------------|--------------|-------|
+| `state` | v1.0.0 | v1000.2.0 | Added `equalityFn` parameter |
+| `derive` | v1.0.0 | v1000.0.0 | Renamed `derived` → `derive` |
+| `effect` | v1.0.0 | - | - |
+| `batch` | v1.0.0 | - | - |
+| `select` | v1000.0.0 | - | - |
+| `lens` | v1000.1.0 | - | - |
+| `readonlyState` | v1000.0.0 | - | - |
+| `protectedState` | v1000.0.0 | v1000.2.0 | Added `equalityFn` parameter |
+
+### Core Primitives
+
+#### `state<T>(initialValue: T, equalityFn?: (a: T, b: T) => boolean): State<T>`
+> *Since v1.0.0*
+
+The foundation of Beacon's reactivity system. Create with `state()` and use like a function.
+
+```typescript
+import { state } from '@nerdalytics/beacon';
+
+const counter = state(0);
+
+// Read current value
+console.log(counter()); // => 0
+
+// Update value
+counter.set(5);
+console.log(counter()); // => 5
 
 // Update with a function
-count.update((n) => n + 1);
-// => "Count is 6, doubled is 12"
+counter.update(n => n + 1);
+console.log(counter()); // => 6
+
+// With custom equality function
+const deepCounter = state({ value: 0 }, (a, b) => {
+  // Deep equality check
+  return a.value === b.value;
+});
+
+// This won't trigger effects because values are deeply equal
+deepCounter.set({ value: 0 });
+```
+
+#### `derive<T>(fn: () => T): ReadOnlyState<T>`
+> *Since v1.0.0*
+
+Calculate values based on other states. Updates automatically when dependencies change.
+
+```typescript
+import { state, derive } from '@nerdalytics/beacon';
+
+const firstName = state('John');
+const lastName = state('Doe');
+
+const fullName = derive(() => `${firstName()} ${lastName()}`);
+
+console.log(fullName()); // => "John Doe"
+
+firstName.set('Jane');
+console.log(fullName()); // => "Jane Doe"
+```
+
+#### `effect(fn: () => void): () => void`
+> *Since v1.0.0*
+
+Run side effects when reactive values change.
+
+```typescript
+import { state, effect } from '@nerdalytics/beacon';
+
+const user = state({ name: 'Alice', loggedIn: false });
+
+const cleanup = effect(() => {
+  console.log(`User ${user().name} is ${user().loggedIn ? 'online' : 'offline'}`);
+});
+// => "User Alice is offline" (effect runs immediately when created)
+
+user.update(u => ({ ...u, loggedIn: true }));
+// => "User Alice is online"
+
+// Stop the effect and clean up all subscriptions
+cleanup();
+```
+
+#### `batch<T>(fn: () => T): T`
+> *Since v1.0.0*
+
+Group multiple updates to trigger effects only once.
+
+```typescript
+import { state, effect, batch } from "@nerdalytics/beacon";
+
+const count = state(0);
+
+effect(() => {
+  console.log(`Count is ${count()}`);
+});
+// => "Count is 0" (effect runs immediately)
+
+// Without batching, effects run after each update
+count.set(1);
+// => "Count is 1"
+count.set(2);
+// => "Count is 2"
 
 // Batch updates (only triggers effects once at the end)
 batch(() => {
   count.set(10);
   count.set(20);
+  count.set(30);
 });
-// => "Count is 20, doubled is 40" (only once)
+// => "Count is 30" (only once)
+```
+
+#### `select<T, R>(source: ReadOnlyState<T>, selectorFn: (state: T) => R, equalityFn?: (a: R, b: R) => boolean): ReadOnlyState<R>`
+> *Since v1000.0.0*
 
-// Using select to subscribe to specific parts of state
-const user = state({ name: "Alice", age: 30, email: "alice@example.com" });
-const nameSelector = select(user, u => u.name);
+Subscribe to specific parts of a state object.
+
+```typescript
+import { state, select, effect } from '@nerdalytics/beacon';
+
+const user = state({
+  profile: { name: 'Alice' },
+  preferences: { theme: 'dark' }
+});
+
+// Only triggers when name changes
+const nameState = select(user, u => u.profile.name);
 
 effect(() => {
-  console.log(`Name changed: ${nameSelector()}`);
+  console.log(`Name: ${nameState()}`);
 });
-// => "Name changed: Alice"
+// => "Name: Alice"
+
+// This triggers the effect
+user.update(u => ({
+  ...u,
+  profile: { ...u.profile, name: 'Bob' }
+}));
+// => "Name: Bob"
+
+// This doesn't trigger the effect (theme changed, not name)
+user.update(u => ({
+  ...u,
+  preferences: { ...u.preferences, theme: 'light' }
+}));
+```
 
-// Updates to the selected property will trigger the effect
-user.update(u => ({ ...u, name: "Bob" }));
-// => "Name changed: Bob"
+#### `lens<T, K>(source: State<T>, accessor: (state: T) => K): State<K>`
+> *Since v1000.1.0*
 
-// Updates to other properties won't trigger the effect
-user.update(u => ({ ...u, age: 31 })); // No effect triggered
+Two-way binding to deeply nested properties.
+
+```typescript
+import { state, lens, effect } from "@nerdalytics/beacon";
 
-// Using lens for two-way binding with nested properties
 const nested = state({
   user: {
     profile: {
@@ -118,165 +282,255 @@ themeLens.set("light");
 console.log(themeLens()); // => "light"
 console.log(nested().user.profile.settings.theme); // => "light"
 
-// Unsubscribe the effect to stop it from running on future updates
-// and clean up all its internal subscriptions
-unsubscribe();
+// The entire object is updated with proper referential integrity
+// This makes it easy to detect changes throughout the object tree
+```
+
+### Access Control
+
+Control who can read vs. write to your state.
+
+#### `readonlyState<T>(state: State<T>): ReadOnlyState<T>`
+> *Since v1000.0.0*
+
+Creates a read-only view of a state, hiding mutation methods. Useful when you want to expose state to other parts of your application without allowing direct mutations.
+
+```typescript
+import { state, readonlyState } from "@nerdalytics/beacon";
 
-// Using readonlyState to create a read-only view
 const counter = state(0);
 const readonlyCounter = readonlyState(counter);
-// readonlyCounter() works, but readonlyCounter.set() is not available
 
-// Using protectedState to separate read and write capabilities
+// Reading works
+console.log(readonlyCounter()); // => 0
+
+// Updating the original state reflects in the readonly view
+counter.set(5);
+console.log(readonlyCounter()); // => 5
+
+// This would cause a TypeScript error since readonlyCounter has no set method
+// readonlyCounter.set(10); // Error: Property 'set' does not exist
+```
+
+#### `protectedState<T>(initialValue: T, equalityFn?: (a: T, b: T) => boolean): [ReadOnlyState<T>, WriteableState<T>]`
+> *Since v1000.0.0*
+
+Creates a state with separated read and write capabilities, returning a tuple of reader and writer. This pattern allows you to expose only the reading capability to consuming code while keeping the writing capability private.
+
+```typescript
+import { protectedState } from "@nerdalytics/beacon";
+
+// Create a state with separated read and write capabilities
 const [getUser, setUser] = protectedState({ name: 'Alice' });
-// getUser() works to read the state
-// setUser.set() and setUser.update() work to modify the state
-// but getUser has no mutation methods
-
-// Infinite loop detection example (would throw an error)
-try {
-  effect(() => {
-    const value = counter();
-    // The following would throw an error because it attempts to
-    // update a state that the effect depends on:
-    // "Infinite loop detected: effect() cannot update a state() it depends on!"
-    // counter.set(value + 1);
-
-    // Instead, use a safe pattern with proper dependencies:
-    console.log(`Current counter value: ${value}`);
-  });
-} catch (error) {
-  console.error('Prevented infinite loop:', error.message);
+
+// Read the state
+console.log(getUser()); // => { name: 'Alice' }
+
+// Update the state
+setUser.set({ name: 'Bob' });
+console.log(getUser()); // => { name: 'Bob' }
+
+// This is useful for exposing only read access to outside consumers
+function createProtectedCounter() {
+  const [getCount, setCount] = protectedState(0);
+
+  return {
+    value: getCount,
+    increment: () => setCount.update(n => n + 1),
+    decrement: () => setCount.update(n => n - 1)
+  };
 }
+
+const counter = createProtectedCounter();
+console.log(counter.value()); // => 0
+counter.increment();
+console.log(counter.value()); // => 1
 ```
 
-## API
+## Advanced Features
 
-### `state<T>(initialValue: T): State<T>`
+Beacon includes several advanced capabilities that help you build robust applications.
 
-Creates a new reactive state container with the provided initial value.
+### Infinite Loop Protection
 
-### `derive<T>(fn: () => T): ReadOnlyState<T>`
+Beacon prevents common mistakes that could cause infinite loops:
 
-Creates a read-only computed value that updates when its dependencies change.
+```typescript
+import { state, effect } from '@nerdalytics/beacon';
 
-### `effect(fn: () => void): () => void`
+const counter = state(0);
 
-Creates an effect that runs the given function immediately and whenever its dependencies change. Returns an unsubscribe function that stops the effect and cleans up all subscriptions when called.
+// This would throw an error
+effect(() => {
+  const value = counter();
+  counter.set(value + 1); // Error: Infinite loop detected!
+});
 
-### `batch<T>(fn: () => T): T`
+// Instead, use proper patterns like:
+const increment = () => counter.update(n => n + 1);
+```
 
-Batches multiple updates to only trigger effects once at the end.
+### Automatic Cleanup
 
-### `select<T, R>(source: ReadOnlyState<T>, selectorFn: (state: T) => R, equalityFn?: (a: R, b: R) => boolean): ReadOnlyState<R>`
+All subscriptions are automatically cleaned up when effects are unsubscribed:
 
-Creates an efficient subscription to a subset of a state value. The selector will only notify its subscribers when the selected value actually changes according to the provided equality function (defaults to `Object.is`).
+```typescript
+import { state, effect } from '@nerdalytics/beacon';
+
+const data = state({ loading: true, items: [] });
+
+// Effect with nested effect
+const cleanup = effect(() => {
+  if (data().loading) {
+    console.log('Loading...');
+  } else {
+    // This nested effect is automatically cleaned up when the parent is
+    effect(() => {
+      console.log(`${data().items.length} items loaded`);
+    });
+  }
+});
 
-### `lens<T, K>(source: State<T>, accessor: (state: T) => K): State<K>`
+// Unsubscribe cleans up everything, including nested effects
+cleanup();
+```
 
-Creates a lens for direct updates to nested properties of a state. A lens combines the functionality of `select` (for reading) with the ability to update the nested property while maintaining referential integrity throughout the object tree.
+### Custom Equality Functions
 
-### `readonlyState<T>(state: State<T>): ReadOnlyState<T>`
+Control when subscribers are notified with custom equality checks. You can provide custom equality functions to `state`, `select`, and `protectedState`:
 
-Creates a read-only view of a state, hiding mutation methods. Useful when you want to expose a state to other parts of your application without allowing direct mutations.
+```typescript
+import { state, select, effect, protectedState } from '@nerdalytics/beacon';
 
-### `protectedState<T>(initialValue: T): [ReadOnlyState<T>, WriteableState<T>]`
+// Custom equality function for state
+// Only trigger updates when references are different (useful for logging)
+const logMessages = state([], (a, b) => a === b); // Reference equality
 
-Creates a state with access control, returning a tuple of reader and writer. This pattern separates read and write capabilities, allowing you to expose only the reading capability to consuming code while keeping the writing capability private.
+// Add logs - each call triggers effects even with identical content
+logMessages.set(['System started']); // Triggers effects
+logMessages.set(['System started']); // Triggers effects again
 
-## Development
+// Protected state with custom equality function
+const [getConfig, setConfig] = protectedState({ theme: 'dark' }, (a, b) => {
+  // Only consider configs equal if all properties match
+  return a.theme === b.theme;
+});
 
-```sh
-# Install dependencies
-npm install
+// Custom equality with select
+const list = state([1, 2, 3]);
 
-# Run all tests
-npm test
+// Only notify when array length changes, not on content changes
+const listLengthState = select(
+  list,
+  arr => arr.length,
+  (a, b) => a === b
+);
 
-# Run all tests with coverage
-npm run test:coverage
-
-# Run specific test suites
-# Core functionality
-npm run test:unit:state
-npm run test:unit:effect
-npm run test:unit:derive
-npm run test:unit:batch
-npm run test:unit:select
-npm run test:unit:lens
-npm run test:unit:readonly
-npm run test:unit:protected
-
-# Advanced patterns
-npm run test:unit:cleanup              # Tests for effect cleanup behavior
-npm run test:unit:cyclic-dependency    # Tests for cyclic dependency handling
-npm run test:unit:deep-chain           # Tests for deep chain handling
-npm run test:unit:infinite-loop        # Tests for infinite loop detection
-
-# Benchmarking
-npm run benchmark    # Tests for infinite loop detection
-
-# Format code
-npm run format
-npm run lint
-npm run check    # Runs Bioms lint + format
+effect(() => {
+  console.log(`List has ${listLengthState()} items`);
+});
 ```
 
-### Node.js LTS Compatibility
+## Design Philosophy
+
+Beacon follows these key principles:
+
+1. **Simplicity**: Minimal API surface with powerful primitives
+2. **Fine-grained reactivity**: Track dependencies at exactly the right level
+3. **Predictability**: State changes flow predictably through the system
+4. **Performance**: Optimize for server workloads and memory efficiency
+5. **Type safety**: Full TypeScript support with generics
+
+## Architecture
+
+Beacon is built around a centralized reactivity system with fine-grained dependency tracking. Here's how it works:
+
+- **Automatic Dependency Collection**: When a state is read inside an effect, Beacon automatically records this dependency
+- **WeakMap-based Tracking**: Uses WeakMaps for automatic garbage collection
+- **Topological Updates**: Updates flow through the dependency graph in the correct order
+- **Memory-Efficient**: Designed for long-running Node.js processes
+
+### Dependency Tracking
+
+When a state is read inside an effect, Beacon automatically records this dependency relationship and sets up a subscription.
+
+### Infinite Loop Prevention
 
-Beacon supports the two most recent Node.js LTS versions (currently v20 and v22). When the package is published to npm, it includes transpiled code compatible with these LTS versions.
+Beacon actively detects when an effect tries to update a state it depends on, preventing common infinite update cycles:
 
-## Key Differences Between My Library and the [TC39 Proposal][1]
+```typescript
+// This would throw: "Infinite loop detected"
+effect(() => {
+  const value = counter();
+  counter.set(value + 1); // Error! Updating a state the effect depends on
+});
+```
 
-| Aspect | @nerdalytics/beacon | TC39 Proposal |
-|--------|---------------------|---------------|
-| **API Style** | Functional approach (`state()`, `derive()`) | Class-based design (`Signal.State`, `Signal.Computed`) |
-| **Reading/Writing Pattern** | Function call for reading (`count()`), methods for writing (`count.set(5)`) | Method-based access (`get()`/`set()`) |
-| **Framework Support** | High-level abstractions like `effect()` and `batch()` | Lower-level primitives (`Signal.subtle.Watcher`) that frameworks build upon |
-| **Advanced Features** | Focused on core reactivity | Includes introspection capabilities, watched/unwatched callbacks, and Signal.subtle namespace |
-| **Scope and Purpose** | Practical Node.js use cases with minimal API surface | Standardization with robust interoperability between frameworks |
+### Cyclic Dependencies
 
-## Implementation Details
+Beacon employs two complementary strategies for handling cyclical updates:
 
-Beacon is designed with a focus on simplicity, performance, and robust handling of complex dependency scenarios.
+1. **Active Detection**: The system tracks which states an effect reads from and writes to. If an effect attempts to directly update a state it depends on, Beacon throws a clear error.
+2. **Safe Cycles**: For indirect cycles and safe update patterns, Beacon uses a queue-based update system that won't crash even with cyclical dependencies. When states form a cycle where values eventually stabilize, the system handles these updates efficiently without stack overflows.
 
-### Key Implementation Concepts
+## Development
 
-- **Fine-grained reactivity**: Dependencies are tracked automatically at the state level
-- **Efficient updates**: Changes only propagate to affected parts of the dependency graph
-- **Cyclical dependency handling**: Robust handling of circular references without crashing
-- **Infinite loop detection**: Safeguards against direct self-mutation within effects
-- **Memory management**: Automatic cleanup of subscriptions when effects are disposed
-- **Optimized batching**: Smart scheduling of updates to minimize redundant computations
+```other
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+```
+
+## Key Differences vs [TC39 Proposal][1]
+
+| **Aspect**                  | **@nerdalytics/beacon**                                                     | **TC39 Proposal**                                                                             |
+| --------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
+| **API Style**               | Functional approach (`state()`, `derive()`)                                 | Class-based design (`Signal.State`, `Signal.Computed`)                                        |
+| **Reading/Writing Pattern** | Function call for reading (`count()`), methods for writing (`count.set(5)`) | Method-based access (`get()`/`set()`)                                                         |
+| **Framework Support**       | High-level abstractions like `effect()` and `batch()`                       | Lower-level primitives (`Signal.subtle.Watcher`) that frameworks build upon                   |
+| **Advanced Features**       | Focused on core reactivity                                                  | Includes introspection capabilities, watched/unwatched callbacks, and Signal.subtle namespace |
+| **Scope and Purpose**       | Practical Node.js use cases with minimal API surface                        | Standardization with robust interoperability between frameworks                               |
 
 ## FAQ
 
-<details>
+#### Why "Beacon" Instead of "Signal"?
 
-<summary>Why "Beacon" Instead of "Signal"?</summary>
-I chose "Beacon" because it clearly represents how the library broadcasts notifications when state changes—just like a lighthouse guides ships. While my library draws inspiration from Preact Signals, Angular Signals, and aspects of Svelte, I wanted to create something lighter and specifically designed for Node.js backends. Using "Beacon" instead of the term "Signal" helps avoid confusion with the TC39 proposal and similar libraries while still accurately describing the core functionality.
+Beacon represents how the library broadcasts notifications when state changes—just like a lighthouse guides ships. The name avoids confusion with the TC39 proposal and similar libraries while accurately describing the core functionality.
 
-</details>
+#### How does Beacon handle memory management?
 
-<details>
+Beacon uses WeakMaps for dependency tracking, ensuring that unused states and effects can be garbage collected. When you unsubscribe an effect, all its internal subscriptions are automatically cleaned up.
 
-<summary>How does Beacon handle infinite update cycles?</summary>
-Beacon employs two complementary strategies for handling cyclical updates:
+#### Can I use Beacon with Express or other frameworks?
 
-1. **Infinite Loop Detection**: Beacon actively detects direct infinite loops in effects by tracking which states an effect reads and writes to. If an effect attempts to update a state it depends on (directly modifying its own dependency), Beacon throws an error with a clear message: "Infinite loop detected: effect() cannot update a state() it depends on!"
+Yes! Beacon works well as a state management solution in any Node.js application:
 
-2. **Safe Cyclic Dependencies**: For indirect cycles and safe update patterns, Beacon uses a queue-based update system that won't crash even with cyclical dependencies. When states form a cycle where values eventually stabilize, the system handles these updates efficiently without stack overflows.
+```typescript
+import express from 'express';
+import { state, effect } from '@nerdalytics/beacon';
 
-This dual approach prevents accidental infinite loops while still supporting legitimate cyclic update patterns that eventually stabilize.
+const app = express();
+const stats = state({ requests: 0, errors: 0 });
 
-</details>
+// Update stats on each request
+app.use((req, res, next) => {
+  stats.update(s => ({ ...s, requests: s.requests + 1 }));
+  next();
+});
 
-<details>
+// Log stats every minute
+effect(() => {
+  console.log(`Stats: ${stats().requests} requests, ${stats().errors} errors`);
+});
+
+app.listen(3000);
+```
 
-<summary>How performant is Beacon?</summary>
-Beacon is designed with performance in mind for server-side Node.js environments. It achieves millions of operations per second for core operations like reading and writing states.
+#### Can Beacon be used in browser applications?
 
-</details>
+While Beacon is optimized for Node.js server-side applications, its core principles would work in browser environments. However, the library is specifically designed for backend use cases and hasn't been optimized for browser bundle sizes or DOM integration patterns.
 
 ## License
 

package/dist/src/index.d.ts

@@ -11,7 +11,7 @@ export type State<T> = ReadOnlyState<T> & WriteableState<T> & {
 /**
  * Creates a reactive state container with the provided initial value.
  */
-export declare const state: <T>(initialValue: T) => State<T>;
+export declare const state: <T>(initialValue: T, equalityFn?: (a: T, b: T) => boolean) => State<T>;
 /**
  * Registers a function to run whenever its reactive dependencies change.
  */
@@ -35,7 +35,7 @@ export declare const readonlyState: <T>(state: State<T>) => ReadOnlyState<T>;
 /**
  * Creates a state with access control, returning a tuple of reader and writer.
  */
-export declare const protectedState: <T>(initialValue: T) => [ReadOnlyState<T>, WriteableState<T>];
+export declare const protectedState: <T>(initialValue: T, equalityFn?: (a: T, b: T) => boolean) => [ReadOnlyState<T>, WriteableState<T>];
 /**
  * Creates a lens for direct updates to nested properties of a state.
  */

package/dist/src/index.js

@@ -3,7 +3,7 @@ const STATE_ID = Symbol();
 /**
  * Creates a reactive state container with the provided initial value.
  */
-export const state = (initialValue) => StateImpl.createState(initialValue);
+export const state = (initialValue, equalityFn = Object.is) => StateImpl.createState(initialValue, equalityFn);
 /**
  * Registers a function to run whenever its reactive dependencies change.
  */
@@ -27,8 +27,8 @@ export const readonlyState = (state) => () => state();
 /**
  * Creates a state with access control, returning a tuple of reader and writer.
  */
-export const protectedState = (initialValue) => {
-    const fullState = state(initialValue);
+export const protectedState = (initialValue, equalityFn = Object.is) => {
+    const fullState = state(initialValue, equalityFn);
     return [
         () => readonlyState(fullState)(),
         {
@@ -60,15 +60,17 @@ class StateImpl {
     value;
     subscribers = new Set();
     stateId = Symbol();
-    constructor(initialValue) {
+    equalityFn;
+    constructor(initialValue, equalityFn = Object.is) {
         this.value = initialValue;
+        this.equalityFn = equalityFn;
     }
     /**
      * Creates a reactive state container with the provided initial value.
      * Implementation of the public 'state' function.
      */
-    static createState = (initialValue) => {
-        const instance = new StateImpl(initialValue);
+    static createState = (initialValue, equalityFn = Object.is) => {
+        const instance = new StateImpl(initialValue, equalityFn);
         const get = () => instance.get();
         get.set = (value) => instance.set(value);
         get.update = (fn) => instance.update(fn);
@@ -104,7 +106,7 @@ class StateImpl {
     // Handles value updates with built-in optimizations and safeguards
     set = (newValue) => {
         // Skip updates for unchanged values to prevent redundant effect executions
-        if (Object.is(this.value, newValue)) {
+        if (this.equalityFn(this.value, newValue)) {
             return;
         }
         // Infinite loop detection prevents direct self-mutation within effects,

package/package.json

@@ -1,16 +1,11 @@
 {
 	"name": "@nerdalytics/beacon",
-	"version": "1000.1.1",
+	"version": "1000.2.0",
 	"description": "A lightweight reactive state library for Node.js backends. Enables reactive state management with automatic dependency tracking and efficient updates for server-side applications.",
 	"type": "module",
 	"main": "dist/src/index.js",
 	"types": "dist/src/index.d.ts",
-	"files": [
-		"dist/src/index.js",
-		"dist/src/index.d.ts",
-		"src/index.ts",
-		"LICENSE"
-	],
+	"files": ["dist/src/index.js", "dist/src/index.d.ts", "src/index.ts", "LICENSE"],
 	"repository": {
 		"url": "git+https://github.com/nerdalytics/beacon.git",
 		"type": "git"
@@ -34,6 +29,7 @@
 		"test:unit:cyclic-dependency": "node --test tests/cyclic-dependency.test.ts",
 		"test:unit:deep-chain": "node --test tests/deep-chain.test.ts",
 		"test:unit:infinite-loop": "node --test tests/infinite-loop.test.ts",
+		"test:unit:custom-equality": "node --test tests/custom-equality.test.ts",
 		"benchmark": "node scripts/benchmark.ts",
 		"build": "npm run build:lts",
 		"prebuild:lts": "rm -rf dist/",
@@ -66,11 +62,11 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@biomejs/biome": "1.9.4",
-		"@types/node": "22.14.0",
+		"@types/node": "22.14.1",
 		"typescript": "5.8.3"
 	},
 	"engines": {
 		"node": ">=20.0.0"
 	},
-	"packageManager": "npm@11.2.0"
+	"packageManager": "npm@11.3.0"
 }

package/src/index.ts

@@ -18,7 +18,8 @@ export type State<T> = ReadOnlyState<T> &
 /**
  * Creates a reactive state container with the provided initial value.
  */
-export const state = <T>(initialValue: T): State<T> => StateImpl.createState(initialValue)
+export const state = <T>(initialValue: T, equalityFn: (a: T, b: T) => boolean = Object.is): State<T> =>
+	StateImpl.createState(initialValue, equalityFn)
 
 /**
  * Registers a function to run whenever its reactive dependencies change.
@@ -55,8 +56,11 @@ export const readonlyState =
 /**
  * Creates a state with access control, returning a tuple of reader and writer.
  */
-export const protectedState = <T>(initialValue: T): [ReadOnlyState<T>, WriteableState<T>] => {
-	const fullState = state(initialValue)
+export const protectedState = <T>(
+	initialValue: T,
+	equalityFn: (a: T, b: T) => boolean = Object.is
+): [ReadOnlyState<T>, WriteableState<T>] => {
+	const fullState = state(initialValue, equalityFn)
 	return [
 		(): T => readonlyState(fullState)(),
 		{
@@ -93,17 +97,19 @@ class StateImpl<T> {
 	private value: T
 	private subscribers = new Set<Subscriber>()
 	private stateId = Symbol()
+	private equalityFn: (a: T, b: T) => boolean
 
-	constructor(initialValue: T) {
+	constructor(initialValue: T, equalityFn: (a: T, b: T) => boolean = Object.is) {
 		this.value = initialValue
+		this.equalityFn = equalityFn
 	}
 
 	/**
 	 * Creates a reactive state container with the provided initial value.
 	 * Implementation of the public 'state' function.
 	 */
-	static createState = <T>(initialValue: T): State<T> => {
-		const instance = new StateImpl<T>(initialValue)
+	static createState = <T>(initialValue: T, equalityFn: (a: T, b: T) => boolean = Object.is): State<T> => {
+		const instance = new StateImpl<T>(initialValue, equalityFn)
 		const get = (): T => instance.get()
 		get.set = (value: T): void => instance.set(value)
 		get.update = (fn: (currentValue: T) => T): void => instance.update(fn)
@@ -143,7 +149,7 @@ class StateImpl<T> {
 	// Handles value updates with built-in optimizations and safeguards
 	set = (newValue: T): void => {
 		// Skip updates for unchanged values to prevent redundant effect executions
-		if (Object.is(this.value, newValue)) {
+		if (this.equalityFn(this.value, newValue)) {
 			return
 		}