Skip to main content

Signal<T>

Defined in: js-api/src/u2core/signals-core.ts:368

The base class for plain and computed signals.

Type Parameters

Type ParameterDefault type
Tany

Constructors

Constructor

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

Defined in: js-api/src/u2core/signals-core.ts:320

Parameters

ParameterType
value?T
options?SignalOptions<T>

Returns

Signal<T>

Properties

PropertyTypeDescriptionDefined in
_batchSnapshotVersionnumberInternaljs-api/src/u2core/signals-core.ts:318
_node?NodeInternaljs-api/src/u2core/signals-core.ts:312
_targets?NodeInternaljs-api/src/u2core/signals-core.ts:315
_valueunknownInternaljs-api/src/u2core/signals-core.ts:302
_versionnumberInternal Version numbers should always be >= 0, because the special value -1 is used by Nodes to signify potentially unused but recyclable nodes.js-api/src/u2core/signals-core.ts:309
brandtypeof BRAND_SYMBOL-js-api/src/u2core/signals-core.ts:349
name?string-js-api/src/u2core/signals-core.ts:339

Accessors

value

Get Signature

get value(): T

Defined in: js-api/src/u2core/signals-core.ts:351

Returns

T

Set Signature

set value(value): void

Defined in: js-api/src/u2core/signals-core.ts:352

Parameters
ParameterType
valueT
Returns

void

Methods

_refresh()

_refresh(): boolean

Defined in: js-api/src/u2core/signals-core.ts:323

Internal

Returns

boolean


_subscribe()

_subscribe(node): void

Defined in: js-api/src/u2core/signals-core.ts:326

Internal

Parameters

ParameterType
nodeNode

Returns

void


_unsubscribe()

_unsubscribe(node): void

Defined in: js-api/src/u2core/signals-core.ts:329

Internal

Parameters

ParameterType
nodeNode

Returns

void


_unwatched()?

optional _unwatched(this): void

Defined in: js-api/src/u2core/signals-core.ts:335

Internal

Parameters

ParameterType
thisSignal<T>

Returns

void


_watched()?

optional _watched(this): void

Defined in: js-api/src/u2core/signals-core.ts:332

Internal

Parameters

ParameterType
thisSignal<T>

Returns

void


peek()

peek(): T

Defined in: js-api/src/u2core/signals-core.ts:347

Returns

T


subscribe()

subscribe(fn): () => void

Defined in: js-api/src/u2core/signals-core.ts:337

Parameters

ParameterType
fn(value) => void

Returns

() => void


toJSON()

toJSON(): T

Defined in: js-api/src/u2core/signals-core.ts:345

Returns

T


toString()

toString(): string

Defined in: js-api/src/u2core/signals-core.ts:343

Returns

string


valueOf()

valueOf(): T

Defined in: js-api/src/u2core/signals-core.ts:341

Returns

T