[]previous and next page

readSignal

Reads a signal's value, subscribing the running computation to it when one is listening.

Reads a signal's value, subscribing the running computation to it when one is listening. The reader of a custom primitive built on createSignalNode.

Import#

ts
import { readSignal } from "@shadow-js/core/extend";

Signature#

ts
function readSignal<T>(signal: Signal<T>): T

Parameters#

Name Description
signal The signal to read.

Returns#

The current value.

Examples#

ts
import { createSignalNode, readSignal } from "@shadow-js/core/extend";

const name = createSignalNode("Ada", Object.is);
export const getName = (): string => readSignal(name);