All files / src/internal/client/reactivity deriveds.js

97.85% Statements 137/140
95.23% Branches 20/21
100% Functions 5/5
97.76% Lines 131/134

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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 1432x 2x 2x                 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 10364x 20x 20x 20x 10364x 10364x 10364x 2x 2x 2x 2x 2x 2x 2x 2x 5639x 5639x 5639x 5639x 2x 2x 2x 2x 2x 16249x 16249x 16249x 16249x 24x 24x 24x 28x 28x 14x 28x 14x 14x 28x 24x 16249x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 16236x 16236x 16236x 16236x 16236x 1x 1x 16235x 16235x 16235x 16235x 16235x 16236x 16236x 16236x 16236x       16231x 16231x 16236x 16236x 16236x 16236x 16236x 16236x 16236x 16034x 16034x 16034x 16236x 2x 2x 2x 2x 2x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x 14x  
/** @import { Derived, Effect } from '#client' */
import { DEV } from 'esm-env';
import { CLEAN, DERIVED, DESTROYED, DIRTY, MAYBE_DIRTY, UNOWNED } from '../constants.js';
import {
	current_reaction,
	current_effect,
	remove_reactions,
	set_signal_status,
	current_skip_reaction,
	update_reaction,
	increment_version
} from '../runtime.js';
import { equals, safe_equals } from './equality.js';
import * as e from '../errors.js';
import { destroy_effect } from './effects.js';
 
/**
 * @template V
 * @param {() => V} fn
 * @returns {Derived<V>}
 */
/*#__NO_SIDE_EFFECTS__*/
export function derived(fn) {
	let flags = DERIVED | DIRTY;
	if (current_effect === null) flags |= UNOWNED;
 
	/** @type {Derived<V>} */
	const signal = {
		children: null,
		deps: null,
		equals,
		f: flags,
		fn,
		reactions: null,
		v: /** @type {V} */ (null),
		version: 0
	};
 
	if (current_reaction !== null && (current_reaction.f & DERIVED) !== 0) {
		var derived = /** @type {Derived} */ (current_reaction);
		(derived.children ??= []).push(signal);
	}
 
	return signal;
}
 
/**
 * @template V
 * @param {() => V} fn
 * @returns {Derived<V>}
 */
/*#__NO_SIDE_EFFECTS__*/
export function derived_safe_equal(fn) {
	const signal = derived(fn);
	signal.equals = safe_equals;
	return signal;
}
 
/**
 * @param {Derived} derived
 * @returns {void}
 */
function destroy_derived_children(derived) {
	var children = derived.children;
 
	if (children !== null) {
		derived.children = null;
 
		for (var i = 0; i < children.length; i += 1) {
			var child = children[i];
			if ((child.f & DERIVED) !== 0) {
				destroy_derived(/** @type {Derived} */ (child));
			} else {
				destroy_effect(/** @type {Effect} */ (child));
			}
		}
	}
}
 
/**
 * The currently updating deriveds, used to detect infinite recursion
 * in dev mode and provide a nicer error than 'too much recursion'
 * @type {Derived[]}
 */
let stack = [];
 
/**
 * @param {Derived} derived
 * @returns {void}
 */
export function update_derived(derived) {
	var value;
 
	if (DEV) {
		try {
			if (stack.includes(derived)) {
				e.derived_references_self();
			}
 
			stack.push(derived);
 
			destroy_derived_children(derived);
			value = update_reaction(derived);
		} finally {
			stack.pop();
		}
	} else {
		destroy_derived_children(derived);
		value = update_reaction(derived);
	}
 
	var status =
		(current_skip_reaction || (derived.f & UNOWNED) !== 0) && derived.deps !== null
			? MAYBE_DIRTY
			: CLEAN;
 
	set_signal_status(derived, status);
 
	if (!derived.equals(value)) {
		derived.v = value;
		derived.version = increment_version();
	}
}
 
/**
 * @param {Derived} signal
 * @returns {void}
 */
function destroy_derived(signal) {
	destroy_derived_children(signal);
	remove_reactions(signal, 0);
	set_signal_status(signal, DESTROYED);
 
	// TODO we need to ensure we remove the derived from any parent derives
 
	signal.children =
		signal.deps =
		signal.reactions =
		// @ts-expect-error `signal.fn` cannot be `null` while the signal is alive
		signal.fn =
			null;
}