Get Started

Spark AR Studio
Spark AR Hub
Features
Learn
Gallery
Partners
Blog
Forum

Create AR effects for Instagram and Facebook.
Get Started

ReactiveModule Overview

ReactiveModule Overview

StringSignal

StringSignal

Contents

Contents

The StringSignal class monitors a string value.

Properties

This module exposes no properties.

Methods

Method	Description
`concat`	concat(other: StringSignal \| string): StringSignal Returns a `StringSignal` containing the concatenation of the values specified by the input signals. See Also: `ReactiveModule.concat`
`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: StringSignal \| string): 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. See Also: `ReactiveModule.eq`
`history`	history(framesCount: number, initialValues?: Array<string>): SignalHistory<string> 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.
`monitor`	monitor(config?: {fireOnInitialValue?: false \| true}): EventSource<{newValue: string, oldValue: string}> 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": string, "newValue": string } 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: StringSignal \| string): 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. See Also: `ReactiveModule.ne`
`pin`	pin(): StringSignal Returns a `StringSignal` containing a constant value which is the value of the specified signal immediately after `pin` is called.
`pinLastValue`	pinLastValue(): ConstStringSignal Returns a `ConstStringSignal` containing a constant value which is the last value of the specified signal before `pinLastValue` is called. ConstScalarSignal can be passed to a functions which accept numbers.