Class BooleanSignal

Boolean Signal.

A signal for a one-bit value that can be true or false.

Hierarchy (View Summary)

Signal<boolean>
- BooleanSignal

Index

Constructors

Accessors

access subscribed type value

Methods

subscribe unsubscribe

Constructors

constructor

new BooleanSignal(value: boolean, access: Access): BooleanSignal
Parameters
- value: boolean
- access: Access
Returns BooleanSignal
Overrides Signal.constructor

Accessors

access

get access(): Access
The accessibility.

Returns Access
Inherited from Signal.access

subscribed

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

Returns boolean
Inherited from Signal.subscribed

type

get type(): DataType
The data type.

Returns DataType
Inherited from Signal.type

value

get value(): boolean
The value.

Returns boolean
Overrides Signal.value
set value(value: boolean): void
The value.
Parameters
- value: boolean
Returns void
Overrides Signal.value

Methods

subscribe(subscriber: Subscriber<boolean>): void
Subscribes to be notified when an event occurs.
Parameters
- subscriber: Subscriber<boolean>
  The callback function.
Returns void
Inherited from Signal.subscribe

unsubscribe

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

Inherited from Signal.unsubscribe