Skip to content

@serenity-is/domwise / signal

Variable: signal()

const signal: {<T>(value, options?): Signal<T>; <T>(): Signal<T | undefined>; }

Defined in: src/signals.ts:43

Creates a new writable signal with an optional initial value. Re-exported from @preact/signals-core with typed overloads.

Call Signature

<T>(value, options?): Signal<T>

Type Parameters

T

T

Parameters

value

T

options?

SignalOptions<T>

Returns

Signal<T>

Call Signature

<T>(): Signal<T | undefined>

Type Parameters

T

T = undefined

Returns

Signal<T | undefined>

Type Param

Type of the signal's value.

Param

Optional initial value for the signal. When omitted the signal starts as undefined.

Param

Optional signal options (watched, unwatched, name).

Returns

A writable Signal<T>.

Example

const count = signal(0);
count.value++;