Skip to content

@jsvision/ui / Signal

Interface: Signal()<T> ​

Defined in: ui/src/reactive/types.ts:19

A writable reactive value. Call it to read (and, inside a tracked computation, subscribe); .set/.update write; .peek() reads without subscribing.

Type Parameters ​

T ​

T

Signal(): T

Defined in: ui/src/reactive/types.ts:21

Read the current value; subscribes the running computation, if any.

Returns ​

T

Methods ​

peek() ​

peek(): T

Defined in: ui/src/reactive/types.ts:27

Read the current value without subscribing the running computation.

Returns ​

T


set() ​

set(value): void

Defined in: ui/src/reactive/types.ts:23

Replace the value; notifies subscribers unless the new value is equal under the equality policy.

Parameters ​

value ​

T

Returns ​

void


update() ​

update(fn): void

Defined in: ui/src/reactive/types.ts:25

Replace the value derived from its predecessor; update(fn) is set(fn(peek())).

Parameters ​

fn ​

(previous) => T

Returns ​

void