All files / src/primitives signal.ts

100% Statements 27/27
100% Branches 10/10
100% Functions 3/3
100% Lines 27/27

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64  1x                                                         1x 452x 452x 452x 452x   452x 594x 594x 540x 540x 540x 594x 594x   452x 344x 72x 72x 272x 272x 272x 344x       452x   2x 2x   452x 452x  
// packages/core/src/signal.ts
import { effectStack, dirtyEffects, flushQueue } from '../internal/scheduler';
import type { Subscriber } from '../internal/scheduler';
import type { SignalGetter, SignalSetter, ReactiveOptions } from '../types';
 
/**
 * Creates a reactive signal that holds a value and automatically tracks dependencies.
 *
 * Signals are the fundamental building blocks of reactivity in Aided. When a signal's
 * value changes, all effects that depend on it are automatically re-executed.
 *
 * @param value The initial value of the signal
 * @param options Optional configuration including debug name
 * @returns A tuple containing [getter, setter] functions
 *
 * @example
 * ```typescript
 * const [count, setCount] = createSignal(0);
 *
 * // Reading the signal tracks dependencies
 * console.log(count()); // 0
 *
 * // Writing updates the value and notifies dependents
 * setCount(5);
 * console.log(count()); // 5
 *
 * // Signals are equal by value, not reference
 * setCount(5); // No change - equal values don't trigger updates
 * ```
 */
export function createSignal<T>(
  value: T,
  options?: ReactiveOptions
): [SignalGetter<T>, SignalSetter<T>] {
  const subscribers = new Set<Subscriber>();
 
  const read: SignalGetter<T> = (): T => {
    const currentEffect = effectStack[effectStack.length - 1];
    if (currentEffect) {
      subscribers.add(currentEffect);
      currentEffect.dependencies.add(subscribers);
    }
    return value;
  };
 
  const write: SignalSetter<T> = (newValue: T) => {
    if (Object.is(value, newValue)) {
      return;
    }
    value = newValue;
    subscribers.forEach((sub) => dirtyEffects.add(sub));
    flushQueue();
  };
 
  // We can attach the name to the read function for debugging purposes.
  // This is a common pattern in reactive libraries.
  if (process.env.NODE_ENV !== 'production' && options?.name) {
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    (read as any)._name = options.name;
  }
 
  return [read, write];
}