All files / solid/src derive.ts

100% Statements 21/21
100% Branches 4/4
100% Functions 2/2
100% Lines 21/21

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 471x 1x 1x                                           1x 2x 2x 2x 2x 2x 2x   2x 3x 2x   2x   2x 2x 2x 2x 2x   2x 2x  
import { anchor, type Immutable, subscribe } from '@anchorlib/core';
import { onCleanup } from 'solid-js';
import { REF_REGISTRY } from './reactive.js';
import type { ConstantRef, StateRef } from './types.js';
 
/**
 * @deprecated Use `derived()` instead.
 * Creates a derived reference that transforms the value of a source state.
 *
 * This function takes a source state and a transformation function, and returns
 * a new constant reference whose value is automatically updated whenever the
 * source state changes. The transformation function is called with the current
 * value of the source state, and its return value becomes the new value of the
 * derived reference.
 *
 * The derived reference is automatically cleaned up when the containing SolidJS
 * component is unmounted.
 *
 * @template T - The type of the source state
 * @template R - The type of the derived value
 * @param state - The source state to derive from
 * @param transform - A function that transforms the source state value into the derived value
 * @returns A constant reference containing the transformed value
 */
export function derivedRef<T, R>(state: T, transform: (current: T) => R): ConstantRef<Immutable<R>> {
  const valueRef = anchor({}, { recursive: false }) as StateRef<R>;
  const stateRef = {
    get value() {
      return valueRef.value;
    },
  };
 
  const unsubscribe = subscribe(state, (current) => {
    valueRef.value = transform(current);
  });
 
  REF_REGISTRY.add(stateRef);
 
  onCleanup(() => {
    anchor.destroy(valueRef);
    unsubscribe();
    REF_REGISTRY.delete(stateRef);
  });
 
  return stateRef as ConstantRef<Immutable<R>>;
}