Skip to content

Interface: SignalState<T>

Documentation / @xmachines/play-signals / SignalState

Defined in: packages/play-signals/src/types.ts:53

Writable state signal holding a single reactive value

Signal.State is the fundamental primitive for reactive state. Calling get() within a computed signal or watcher automatically tracks the state as a dependency. Calling set() notifies all dependent computations and watchers.

Example

import { Signal } from "@xmachines/play-signals";
const name = new Signal.State("Alice");
console.log(name.get()); // 'Alice'
name.set("Bob");
console.log(name.get()); // 'Bob'

Type Parameters

Type Parameter
T

Methods

get()

get(): T;

Defined in: packages/play-signals/src/types.ts:59

Read current value and track as dependency

Returns

T

Current value of the signal


set()

set(value): void;

Defined in: packages/play-signals/src/types.ts:66

Write new value and notify watchers if changed

Parameters

ParameterTypeDescription
valueTNew value to set

Returns

void