Skip to content

Interface: ReadonlySignal<T>

Defined in: @preact/signals-core:

An interface for read-only signals.

Extends

  • ReactElement

Type Parameters

Type ParameterDefault type
Tany

Methods

peek()

ts
peek(): T;

Defined in: @preact/signals-core:

Returns

T


subscribe()

ts
subscribe(fn: (value: T) => void): () => void;

Defined in: @preact/signals-core:

Parameters

ParameterType
fn(value: T) => void

Returns

() => void


toJSON()

ts
toJSON(): T;

Defined in: @preact/signals-core:

Returns

T


toString()

ts
toString(): string;

Defined in: @preact/signals-core:

Returns

string


valueOf()

ts
valueOf(): T;

Defined in: @preact/signals-core:

Returns

T

Properties

brand

ts
brand: typeof BRAND_SYMBOL;

Defined in: @preact/signals-core:


key

ts
key: string | null;

Defined in: @types/react:


props

ts
props: unknown;

Defined in: @types/react:


type

ts
type: string | JSXElementConstructor<any>;

Defined in: @types/react:


value

ts
readonly value: T;

Defined in: @preact/signals-core: