ReactiveModule Overview
ReactiveModule Overview
BoolSignal

BoolSignal

Contents

Properties
Methods

Contents

Properties
Methods

The BoolSignal class monitors a boolean value.

Properties

This module exposes no properties.

Methods

MethodDescription
and 
and(other: BoolSignal): BoolSignal


Returns a signal with the value that is the logical conjunction of the values of the given signals. It is true every time both input signals are true and false at all other times.
See Also: BoolSignal.and
delayBy 
delayBy(timeSpan: {milliseconds: number}): ISignal


Delays a signal. The argument is an object with a "milliseconds" property specifying the delay duration in milliseconds.
eq 
eq(other: BoolSignal | boolean): BoolSignal


Returns a Boolean signal that takes the value of true every time when the value of the left-hand-side signal is equal to the value of the right-hand-side one, and the value of false all other time.
Note: the scalar values are tested for exact equality. For some applications it might be reasonable to perform a non-strict comparison allowing the values to be within a small distance one from another.

See Also: ReactiveModule.eq
history 
history(framesCount: number, initialValues?: Array<boolean>): SignalHistory<boolean>


Returns an object used to access signal values from past frames. The amount of frames tracked is customizable via framesCount parameter.
Historical signal values are going to be initialized with signal value at call time or using initialValues if provided.
ifThenElse 
ifThenElse<T, U>(thenValue: EventSource<T>, elseValue: EventSource<U>): EventSource<T | U>
ifThenElse(thenValue: ScalarSignal | number, elseValue: ScalarSignal | number): ScalarSignal
ifThenElse(thenValue: StringSignal | string, elseValue: StringSignal | string): StringSignal
ifThenElse(thenValue: BoolSignal | boolean, elseValue: BoolSignal | boolean): BoolSignal


Returns a signal or an EventSource which at any point of time takes the value (passes the events in case of EventSource) of one or another inputs, depending on the momentary value of the given BoolSignal.
monitor 
monitor(config?: {fireOnInitialValue?: false | true}): EventSource<{newValue: boolean, oldValue: boolean}>


Returns an EventSource that emits an event every time the value of the input signal changes. The event contains a JSON object with the old and new values in the format:
{ "oldValue": boolean, "newValue": boolean }


Note: By default, there is no event fired for the initial value of the signal. If config.fireOnInitialValue is set to true then an event for initial signal value is also emitted. oldValue is unset for this initial event.
ne 
ne(other: BoolSignal | boolean): BoolSignal


Returns a Boolean signal that takes the value of true every time when the value of the left-hand-side signal is not equal to the value of the right-hand-side one, and the value of false all other time.
Note: the scalar values are tested for exact equality. For some applications it might be reasonable to perform a non-strict comparison allowing the values to be within a small distance one from another.

See Also: ReactiveModule.ne
not 
not(): BoolSignal


Returns a signal with the logically negated value of the given signal.
See Also: ReactiveModule.not
onOff 
onOff(config?: {fireOnInitialValue?: false | true}): EventSource<{newValue: boolean, oldValue: boolean}>


Returns an EventSource that emits an event every time the value of the input signal changes to false. The event contains a JSON object with the old and new values in the format:
{ "oldValue": boolean, "newValue": boolean }


Note: By default, there is no event fired for the initial value of the signal if it's false straight away. If config.fireOnInitialValue is set to true then an event for initial signal value is also emitted. oldValue is unset for this initial event.
onOn 
onOn(config?: {fireOnInitialValue?: false | true}): EventSource<{newValue: boolean, oldValue: boolean}>


Returns an EventSource that emits an event every time the value of the input signal changes to true. The event contains a JSON object with the old and new values in the format:
{ "oldValue": boolean, "newValue": boolean }


Note: By default, there is no event fired for the initial value of the signal if it's true straight away. If config.fireOnInitialValue is set to true then an event for initial signal value is also emitted. oldValue is unset for this initial event.
or 
or(other: BoolSignal): BoolSignal


Returns a signal with the value that is the logical disjunction of the values of the given signals. It is true every time at least one of the input signals is true and false at all other times.
See Also: BoolSignal.or
pin 
pin(): BoolSignal


Returns a BoolSignal containing a constant value which is the value of the specified signal immediately after pin is called.
pinLastValue 
pinLastValue(): ConstBoolSignal


Returns a ConstBoolSignal containing a constant value which is the last value of the specified signal before pinLastValue is called.
ConstBoolSignal can be passed to a functions which accept numbers.
xor 
xor(other: BoolSignal | boolean): BoolSignal


Returns a signal with the value that is the logical exclusive disjunction of the values of the given signals. It is true every time exactly one of the input signals is true and false at all other times.
Note: It is equivalent to BoolSignal.ne.

See Also: ReactiveModule.xor

Was this article helpful?