Class Signal<T>`Abstract`

Signal.

A signal wraps a value and notifies subscribers when the value is set.

Remarks

Subscribers are not notified unless the value is set to a different value. It is recommended to subscribe to signals through Component.subscribe.

Type Parameters

T extends SignalValueType

Hierarchy (View Summary)

Subscribable<T>
- Signal

Implements

IReadable<T>
IWritable<T>

Index

Constructors

Accessors

access subscribed type value

Methods

subscribe unsubscribe

Constructors

constructor

new Signal<T extends SignalValueType>(type: DataType, access: Access): Signal<T>
Constructor.
Type Parameters
- T extends SignalValueType
Parameters
- type: DataType
  The data type.
- access: Access
  The accessibility.
Returns Signal<T>
Overrides Subscribable<T>.constructor

Accessors

access

get access(): Access
The accessibility.

Returns Access

subscribed

get subscribed(): boolean
Whether there are any subscribers.

Returns boolean
Implementation of IReadable.subscribed
Inherited from Subscribable.subscribed

type

get type(): DataType
The data type.

Returns DataType

`Abstract`value

get value(): T
The value.

Returns T
Implementation of IReadable.value
set value(value: T): void
Parameters
- value: T
Returns void
Implementation of IReadable.value

Methods

subscribe(subscriber: Subscriber<T>): void
Subscribes to be notified when an event occurs.
Parameters
- subscriber: Subscriber<T>
  The callback function.
Returns void
Implementation of IWritable.subscribe
Inherited from Subscribable.subscribe

unsubscribe

unsubscribe(callback: Subscriber<T>): boolean
Unsubscribes.
Parameters
- callback: Subscriber<T>
  The callback function.
Returns boolean
True if the subscription was canceled, false otherwise.

Implementation of IWritable.unsubscribe
Inherited from Subscribable.unsubscribe