Misc

Action

Action(init): NodeRef<void>

Defines a new stateless, valueless node and returns a reference to it. Once a realm instance publishes or subscribes to the node, an instance of that node it will be registered in the realm.

Parameters

Parameter	Type	Default value	Description
init	NodeInit<void>	noop	an optional function that will be called when the node is registered in a realm. Can be used to create subscriptions and define relationships to other nodes. Any referred nodes will be registered in the realm automatically.

Returns

NodeRef<void>

Example

ts

Remarks

An action is just a signal with void value. It can be used to trigger side effects.

---

AsyncQuery

AsyncQuery<I, O>(query, defaultParams): PipeRef<I, QueryResult<O>>

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
query	(params) => Promise<O>
defaultParams	I

Returns

PipeRef<I, QueryResult<O>>

---

Cell

Cell<T>(value, init, distinct): NodeRef<T>

Defines a new stateful node and returns a reference to it. Once a realm instance publishes or subscribes to the node, an instance of that node it will be registered in the realm.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value	Description
value	T	undefined	the initial value of the node. Stateful nodes always have a value.
init	(r) => void	noop	an optional function that will be called when the node is registered in a realm. Can be used to create subscriptions and define relationships to other nodes. Any referred nodes will be registered in the realm automatically.
distinct	Distinct<T>	true	if true, the node will only emit values that are different from the previous value. Optionally, a custom distinct function can be provided if the node values are non-primitive.

Returns

NodeRef<T>

Example

ts

Remarks

Unlike the RxJS BehaviorSubject, a stateful node does not immediately invoke its subscriptions when subscribed to. It only emits values when you publish something in it, either directly or through its relationships. If you need to get the current value of a stateful node, use Realm.getValue.

---

changeWith

const changeWith: Realm["changeWith"]

---

combine

const combine: Realm["combine"]

---

Comparator

Comparator<T> = (previous, current) => boolean

A function which determines if two values are equal. Implement custom comparators for distinct nodes that contain non-primitive values.

Type Parameters

Type Parameter	Description
T	The type of values that the comparator compares.

Parameters

Parameter	Type	Description
previous	T | undefined	The value that previously passed through the node. can be undefined if the node has not emitted a value yet.
current	T	The value currently passing.

Returns

boolean

true if values should be considered equal.

---

debounceTime

debounceTime<I>(delay): Operator<I, I>

Debounces the output of a node with the specified delay.

Type Parameters

Type Parameter
I

Parameters

Parameter	Type
delay	number

Returns

Operator<I, I>

---

defaultComparator

defaultComparator<T>(current, next): boolean

The default comparator for distinct nodes - a function to determine if two values are equal. Works for primitive values.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
current	T
next	T

Returns

boolean

---

delayWithMicrotask

delayWithMicrotask<I>(): Operator<I, I>

Delays the output of a node with queueMicrotask.

Type Parameters

Type Parameter
I

Returns

Operator<I, I>

---

DerivedCell

DerivedCell<T>(value, linkFn, distinct): NodeRef<T>

Defines a new stateful node, links it to an existing node transform and returns a reference to it. Once a realm instance publishes or subscribes to the node, an instance of that node it will be registered in the realm.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value	Description
value	T	undefined	the initial value of the node. Stateful nodes always have a value.
linkFn	(r, cell) => NodeRef<T>	undefined	an function that will be called when the node is registered in a realm. Should return a node reference to link to.
distinct	Distinct<T>	true	if true, the node will only emit values that are different from the previous value. Optionally, a custom distinct function can be provided if the node values are non-primitive.

Returns

NodeRef<T>

Example

ts

---

Distinct

Distinct<T> = boolean | Comparator<T>

A type for the distinct parameter to the Cell and Signal constructors.

Type Parameters

Type Parameter	Description
T	The type of values that the node emits.

---

filter

filter<I, O>(predicate): Operator<I, O>

Operator that filters the output of a node. If the predicate returns false, the emission is canceled.

Type Parameters

Type Parameter	Default type
I	-
O	I

Parameters

Parameter	Type
predicate	(value) => boolean

Returns

Operator<I, O>

---

getValue

const getValue: Realm["getValue"]

---

handlePromise

handlePromise<I, OutSuccess, OnLoad, OutError>(onLoad, onSuccess, onError): Operator<I | Promise<I>, OutSuccess | OnLoad | OutError>

Handles a promise value through the specified callbacks.

Type Parameters

Type Parameter
I
OutSuccess
OnLoad
OutError

Parameters

Parameter	Type
onLoad	() => OnLoad
onSuccess	(value) => OutSuccess
onError	(error) => OutError

Returns

Operator<I | Promise<I>, OutSuccess | OnLoad | OutError>

---

Inp

Inp<T> = NodeRef<T> | PipeRef<T>

Type Parameters

Type Parameter	Default type
T	unknown

---

link

const link: Realm["link"]

---

map

map<I, O>(mapFunction): Operator<I, O>

Maps a the passed value with a projection function.

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
mapFunction	(value) => O

Returns

Operator<I, O>

---

mapTo

mapTo<I, O>(value): Operator<I, O>

Operator that maps the output of a node to a fixed value.

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
value	O

Returns

Operator<I, O>

---

NodeInit

NodeInit<T> = (r, node$) => void

A node initializer function.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
r	Realm
node$	NodeRef<T>

Returns

void

---

NodeRef

NodeRef<T> = symbol & object

A typed reference to a node.

Type Declaration

valType

T

Type Parameters

Type Parameter	Default type	Description
T	unknown	The type of values that the node emits.

---

O

O<In, Out> = Operator<In, Out>

Shorter alias for Operator, to avoid extra long type signatures.

Type Parameters

Type Parameter
In
Out

---

once

once<I>(): Operator<I, I>

Operator that captures the first emitted value of a node. Useful if you want to execute a side effect only once.

Type Parameters

Type Parameter
I

Returns

Operator<I, I>

---

onNext

onNext<I, O>(bufNode): Operator<I, [I, O]>

description Buffers the stream of a node until the passed note emits.

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
bufNode	NodeRef<O>

Returns

Operator<I, [I, O]>

---

Operator

Operator<I, O> = (source, realm) => NodeRef<O>

An operator that transforms a node into another node, used in the Realm.pipe method.

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
source	Out<I>
realm	Realm

Returns

NodeRef<O>

---

Out

Out<T> = NodeRef<T> | PipeRef<unknown, T>

Type Parameters

Type Parameter	Default type
T	unknown

---

pipe

const pipe: Realm["pipe"]

---

Pipe

Pipe<I, O>(value, init, distinct): PipeRef<I, O>

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type	Default value
value	O	undefined
init	(r, input$, output$) => void	undefined
distinct	Distinct<I>	true

Returns

PipeRef<I, O>

---

PipeInit

PipeInit<I, O> = (r, inputRef$, outputRef$) => void

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
r	Realm
inputRef$	NodeRef<I>
outputRef$	NodeRef<O>

Returns

void

---

PipeRef

PipeRef<I, O> = symbol & object

Type Declaration

inputType

I

outputType

O

Type Parameters

Type Parameter	Default type
I	unknown
O	unknown

---

ProjectionFunc

ProjectionFunc<T> = (done) => (…args) => void

Type Parameters

Type Parameter	Default type
T extends unknown[]	unknown[]

Parameters

Parameter	Type
done	(…values) => void

Returns

(…args): void

Parameters

Parameter	Type
…args	T

Returns

void

---

pub

const pub: Realm["pub"]

---

pubIn

const pubIn: Realm["pubIn"]

---

Realm

The realm is the actual “engine” that orchestrates any cells and signals that it touches. The realm also stores the state and the dependencies of the nodes that are referred through it.

Constructors

Constructor

new Realm(initialValues): Realm

Creates a new realm.

Parameters

Parameter	Type	Description
initialValues	Record<symbol, unknown>	the initial cell values that will populate the realm. Those values will not trigger a recomputation cycle, and will overwrite the initial values specified for each cell.

Returns

Realm

Methods

cellInstance()

cellInstance<T>(value, distinct, node): NodeRef<T>

Creates or resolves an existing cell instance in the realm. Useful as a joint point when building your own operators.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value	Description
value	T	undefined	the initial value of the cell
distinct	Distinct<T>	true	true by default. Pass false to mark the signal as a non-distinct one, meaning that publishing the same value multiple times will re-trigger a recomputation cycle.
node	symbol	...	optional, a reference to a cell. If the cell has not been touched in the realm before, the realm will instantiate a reference to it. If it’s registered already, the function will return the reference.

Returns

NodeRef<T>

a reference to the cell.

---

changeWith()

changeWith<T, K>(cell, source, map): void

Convenient for mutation of cells that contian non-primitive values (e.g. arrays, or objects). Specifies that the cell value should be changed when source emits, with the result of the map callback parameter. the map parameter gets called with the current value of the cell and the value published through the source.

Type Parameters

Type Parameter	Description
T	the type of the cell value.
K	the type of the value published through the source.

Parameters

Parameter	Type
cell	Inp<T>
source	Out<K>
map	(cellValue, signalValue) => T

Returns

void

Example

ts

---

combine()

Call Signature

combine<T1>(…nodes): Out<T1>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1

Parameters

Parameter	Type
…nodes	[Out<T1>]

Returns

Out<T1>

Call Signature

combine<T1, T2>(…nodes): Out<[T1, T2]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>]

Returns

Out<[T1, T2]>

Call Signature

combine<T1, T2, T3>(…nodes): Out<[T1, T2, T3]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>]

Returns

Out<[T1, T2, T3]>

Call Signature

combine<T1, T2, T3, T4>(…nodes): Out<[T1, T2, T3, T4]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>]

Returns

Out<[T1, T2, T3, T4]>

Call Signature

combine<T1, T2, T3, T4, T5>(…nodes): Out<[T1, T2, T3, T4, T5]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>]

Returns

Out<[T1, T2, T3, T4, T5]>

Call Signature

combine<T1, T2, T3, T4, T5, T6>(…nodes): Out<[T1, T2, T3, T4, T5, T6]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>]

Returns

Out<[T1, T2, T3, T4, T5, T6]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>, Out<T13>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17
T18

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18]>

Call Signature

combine<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19]>

Combines the values from multiple nodes into a single node that emits an array of the latest values of the nodes.

When one of the source nodes emits a value, the combined node emits an array of the latest values from each node.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17
T18
T19

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19]>

---

combineCells()

Call Signature

combineCells<T1>(…nodes): Out<[T1]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1

Parameters

Parameter	Type
…nodes	[Out<T1>]

Returns

Out<[T1]>

Call Signature

combineCells<T1, T2>(…nodes): Out<[T1, T2]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>]

Returns

Out<[T1, T2]>

Call Signature

combineCells<T1, T2, T3>(…nodes): Out<[T1, T2, T3]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>]

Returns

Out<[T1, T2, T3]>

Call Signature

combineCells<T1, T2, T3, T4>(…nodes): Out<[T1, T2, T3, T4]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>]

Returns

Out<[T1, T2, T3, T4]>

Call Signature

combineCells<T1, T2, T3, T4, T5>(…nodes): Out<[T1, T2, T3, T4, T5]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>]

Returns

Out<[T1, T2, T3, T4, T5]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6>(…nodes): Out<[T1, T2, T3, T4, T5, T6]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>]

Returns

Out<[T1, T2, T3, T4, T5, T6]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>, Out<T13>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17
T18

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17
T18
T19

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17
T18
T19
T20

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20]>

Call Signature

combineCells<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21>(…nodes): Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21]>

Combines the values from multiple nodes into a cell that’s an array of the latest values of the nodes.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13
T14
T15
T16
T17
T18
T19
T20
T21

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

Out<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21]>

---

connect()

connect<T>(__namedParameters): void

A low-level utility that connects multiple nodes to a sink node with a map function. Used as a foundation for the higher-level operators. The nodes can be active (sources) or passive (pulls).

Type Parameters

Type Parameter	Default type
T extends unknown[]	unknown[]

Parameters

Parameter	Type	Description
__namedParameters	{ map: ProjectionFunc<T>; pulls?: Out<unknown>[]; sink: Inp; sources: Out<unknown>[]; }	-
__namedParameters.map	ProjectionFunc<T>	The projection function that will be called when any of the source nodes emits.
__namedParameters.pulls?	Out<unknown>[]	The nodes which values will be pulled. The values will be passed as arguments to the map function.
__namedParameters.sink	Inp	The sink node that will receive the result of the map function.
__namedParameters.sources	Out<unknown>[]	The source nodes that emit values to the sink node. The values will be passed as arguments to the map function.

Returns

void

---

getValue()

getValue<T>(node): T

Gets the current value of a node. The node must be stateful.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
node	Out<T>	the node instance.

Returns

T

Remarks

If possible, use withLatestFrom or combine, as getValue will not create a dependency to the passed node, which means that if you call it within a computational cycle, you may not get the correct value.

Example

ts

---

getValues()

Call Signature

getValues<T1>(nodes): [T1]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1

Parameters

Parameter	Type
nodes	[Out<T1>]

Returns

[T1]

Call Signature

getValues<T1, T2>(nodes): [T1, T2]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>]

Returns

[T1, T2]

Call Signature

getValues<T1, T2, T3>(nodes): [T1, T2, T3]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>]

Returns

[T1, T2, T3]

Call Signature

getValues<T1, T2, T3, T4>(nodes): [T1, T2, T3, T4]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>]

Returns

[T1, T2, T3, T4]

Call Signature

getValues<T1, T2, T3, T4, T5>(nodes): [T1, T2, T3, T4, T5]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>]

Returns

[T1, T2, T3, T4, T5]

Call Signature

getValues<T1, T2, T3, T4, T5, T6>(nodes): [T1, T2, T3, T4, T5, T6]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>]

Returns

[T1, T2, T3, T4, T5, T6]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7>(nodes): [T1, T2, T3, T4, T5, T6, T7]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>]

Returns

[T1, T2, T3, T4, T5, T6, T7]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7, T8>(nodes): [T1, T2, T3, T4, T5, T6, T7, T8]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7, T8, T9>(nodes): [T1, T2, T3, T4, T5, T6, T7, T8, T9]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(nodes): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(nodes): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(nodes): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]

Call Signature

getValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(nodes): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>, Out<T13>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]

Call Signature

getValues<T>(nodes): unknown[]

Gets the current values of the specified nodes. Works just like getValue, but with an array of node references.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
nodes	Out<T>[]

Returns

unknown[]

---

inContext()

inContext<T>(fn): T

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
fn	() => T

Returns

T

---

link()

link<T>(source, sink): void

Links the output of a node to the input of another node.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
source	Out<T>
sink	Inp<T>

Returns

void

---

pipe()

Call Signature

pipe<T>(s): NodeRef<T>

Creates a new node that emits the values of the source node transformed through the specified operators.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
s	Out<T>

Returns

NodeRef<T>

Example

ts

---

register()

register(node$): PipeRef<unknown, unknown> | NodeRef<any>

Explicitly includes the specified cell/signal/pipe reference in the realm. Most of the time you don’t need to do that, since any interaction with the node through a realm will register it. The only exception of that rule should be when the interaction is conditional, and the node definition includes an init function that needs to be eagerly evaluated.

Parameters

Parameter	Type
node$	NodeRef<unknown> | PipeRef<unknown, unknown>

Returns

PipeRef<unknown, unknown> | NodeRef<any>

---

resetSingletonSubs()

resetSingletonSubs(): void

Clears all exclusive subscriptions.

Returns

void

---

signalInstance()

signalInstance<T>(distinct, node): NodeRef<T>

Creates or resolves an existing signal instance in the realm. Useful as a joint point when building your own operators.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value	Description
distinct	Distinct<T>	true	true by default. Pass false to mark the signal as a non-distinct one, meaning that publishing the same value multiple times will re-trigger a recomputation cycle.
node	symbol	...	optional, a reference to a signal. If the signal has not been touched in the realm before, the realm will instantiate a reference to it. If it’s registered already, the function will return the reference.

Returns

NodeRef<T>

a reference to the signal.

---

singletonSub()

singletonSub<T>(node, subscription): UnsubscribeHandle

Subscribes exclusively to values in the referred node. Calling this multiple times on a single node will remove the previous subscription created through singletonSub. Subscriptions created through sub are not affected.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
node	Out<T>
subscription	Subscription<T> | undefined

Returns

UnsubscribeHandle

a function that, when called, will cancel the subscription.

Example

ts

---

sub()

sub<T>(node, subscription): UnsubscribeHandle

Subscribes to the values published in the referred node.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
node	Out<T>	the cell/signal to subscribe to.
subscription	Subscription<T>	the callback to execute when the node receives a new value.

Returns

UnsubscribeHandle

a function that, when called, will cancel the subscription.

Example

ts

---

subMultiple()

Call Signature

subMultiple<T1>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1

Parameters

Parameter	Type
nodes	[Out<T1>]
subscription	Subscription<[T1]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>]
subscription	Subscription<[T1, T2]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2, T3>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2
T3

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>]
subscription	Subscription<[T1, T2, T3]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2, T3, T4>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2
T3
T4

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>]
subscription	Subscription<[T1, T2, T3, T4]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2, T3, T4, T5>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>]
subscription	Subscription<[T1, T2, T3, T4, T5]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2, T3, T4, T5, T6>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>]
subscription	Subscription<[T1, T2, T3, T4, T5, T6]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2, T3, T4, T5, T6, T7>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>]
subscription	Subscription<[T1, T2, T3, T4, T5, T6, T7]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple<T1, T2, T3, T4, T5, T6, T7, T8>(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8

Parameters

Parameter	Type
nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>]
subscription	Subscription<[T1, T2, T3, T4, T5, T6, T7, T8]>

Returns

UnsubscribeHandle

Example

ts

Call Signature

subMultiple(nodes, subscription): UnsubscribeHandle

Subscribes to multiple nodes at once. If any of the nodes emits a value, the subscription will be called with an array of the latest values from each node. If the nodes change within a single execution cycle, the subscription will be called only once with the final node values.

Parameters

Parameter	Type
nodes	Out<unknown>[]
subscription	Subscription<any>

Returns

UnsubscribeHandle

Example

ts

---

transformer()

Call Signature

transformer<In>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In

Parameters

Parameter	Type
…o	[]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<In>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out

Parameters

Parameter	Type
…o	[O<In, Out>]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out, O1>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out
O1

Parameters

Parameter	Type
…o	[O<In, O1>, O<O1, Out>]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out, O1, O2>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out
O1
O2

Parameters

Parameter	Type
…o	[O<In, O1>, O<O1, O2>, O<O2, Out>]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out, O1, O2, O3>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out
O1
O2
O3

Parameters

Parameter	Type
…o	[O<In, O1>, O<O1, O2>, O<O2, O3>, O<O3, Out>]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out, O1, O2, O3, O4>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out
O1
O2
O3
O4

Parameters

Parameter	Type
…o	[O<In, O1>, O<O1, O2>, O<O2, O3>, O<O3, O4>, O<O4, Out>]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out, O1, O2, O3, O4, O5>(…o): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out
O1
O2
O3
O4
O5

Parameters

Parameter	Type
…o	[O<In, O1>, O<O1, O2>, O<O2, O3>, O<O3, O4>, O<O4, O5>, O<O5, Out>]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

Call Signature

transformer<In, Out>(…operators): (s) => Inp<In>

Works as a reverse pipe. Constructs a function, that, when passed a certain node (sink), will create a node that will work as a publisher through the specified pipes into the sink.

Type Parameters

Type Parameter
In
Out

Parameters

Parameter	Type
…operators	O<unknown, unknown>[]

Returns

(s): Inp<In>

Parameters

Parameter	Type
s	Inp<Out>

Returns

Inp<In>

Example

ts

---

RealmContext

const RealmContext: Context<Realm | null>

---

RealmProvider

RealmProvider(__namedParameters): Element

Parameters

Parameter	Type	Description
__namedParameters	{ children: ReactNode; initWith?: Record<string, unknown>; updateWith?: Record<string, unknown>; }	-
__namedParameters.children	ReactNode	The children to render
__namedParameters.initWith?	Record<string, unknown>	The initial values to set in the realm
__namedParameters.updateWith?	Record<string, unknown>	The values to update in the realm on each render

Returns

Element

---

scan

scan<I, O>(accumulator, seed): Operator<I, O>

Operator that runs with the latest and the current value of a node. Works like the RxJS scan operator.

Type Parameters

Type Parameter
I
O

Parameters

Parameter	Type
accumulator	(current, value) => O
seed	O

Returns

Operator<I, O>

---

Signal

Signal<T>(init, distinct): NodeRef<T>

Defines a new stateless node and returns a reference to it. Once a realm instance publishes or subscribes to the node, an instance of that node it will be registered in the realm.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Default value	Description
init	NodeInit<T>	noop	an optional function that will be called when the node is registered in a realm. Can be used to create subscriptions and define relationships to other nodes. Any referred nodes will be registered in the realm automatically.
distinct	Distinct<T>	false	true by default. The node emits values that are different from the previous value. Optionally, a custom distinct function can be provided if the node values are non-primitive.

Returns

NodeRef<T>

Example

ts

---

sub

const sub: Realm["sub"]

---

Subscription

Subscription<T> = (value) => unknown

A function that is called when a node emits a value.

Type Parameters

Type Parameter	Description
T	The type of values that the node emits.

Parameters

Parameter	Type
value	T

Returns

unknown

---

throttleTime

throttleTime<I>(delay): Operator<I, I>

Throttles the output of a node with the specified delay.

Type Parameters

Type Parameter
I

Parameters

Parameter	Type
delay	number

Returns

Operator<I, I>

---

UnsubscribeHandle

UnsubscribeHandle = () => void

The resulting type of a subscription to a node. Can be used to cancel the subscription.

Returns

void

---

useCell

useCell<O, I>(cell): [O, (value) => void]

Returns a tuple of the current value of the cell and a publisher function (similar to useState). The component will be re-rendered when the cell value changes.

Type Parameters

Type Parameter	Default type
O	-
I	O

Parameters

Parameter	Type	Description
cell	NodeRef<O> | PipeRef<I, O>	The cell to use.

Returns

[O, (value) => void]

A tuple of the current value of the cell and a publisher function.

Remarks

If you need just a publisher, use usePublisher.

---

useCellValue

const useCellValue: <T>(cell) => T

Gets the current value of the cell. The component is re-rendered when the cell value changes.

Type Parameters

Type Parameter	Description
T	the type of the value that the cell caries.

Parameters

Parameter	Type	Description
cell	Out<T>	The cell to use.

Returns

T

The current value of the cell.

Remarks

If you need the values of multiple nodes from the realm and those nodes might change in the same computation, you can useCellValues to reduce re-renders.

Example

tsx

---

useCellValues

Call Signature

useCellValues<T1>(…cells): [T1]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1

Parameters

Parameter	Type
…cells	[Out<T1>]

Returns

[T1]

Example

tsx

Call Signature

useCellValues<T1, T2>(…cells): [T1, T2]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>]

Returns

[T1, T2]

Example

tsx

Call Signature

useCellValues<T1, T2, T3>(…cells): [T1, T2, T3]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>]

Returns

[T1, T2, T3]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4>(…cells): [T1, T2, T3, T4]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>]

Returns

[T1, T2, T3, T4]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5>(…cells): [T1, T2, T3, T4, T5]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>]

Returns

[T1, T2, T3, T4, T5]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6>(…cells): [T1, T2, T3, T4, T5, T6]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>]

Returns

[T1, T2, T3, T4, T5, T6]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7>(…cells): [T1, T2, T3, T4, T5, T6, T7]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>]

Returns

[T1, T2, T3, T4, T5, T6, T7]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7, T8>(…cells): [T1, T2, T3, T4, T5, T6, T7, T8]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7, T8, T9>(…cells): [T1, T2, T3, T4, T5, T6, T7, T8, T9]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10>(…cells): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11>(…cells): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12>(…cells): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12]

Example

tsx

Call Signature

useCellValues<T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13>(…cells): [T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]

Retreives the values of the passed cells. The component is re-rendered each time any of the referred cells changes its value.

Type Parameters

Type Parameter
T1
T2
T3
T4
T5
T6
T7
T8
T9
T10
T11
T12
T13

Parameters

Parameter	Type
…cells	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>, Out<T9>, Out<T10>, Out<T11>, Out<T12>, Out<T13>]

Returns

[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13]

Example

tsx

---

usePublisher

usePublisher<T>(node): (value) => void

Returns a function that publishes its passed argument into the specified node.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
node	Inp<T>

Returns

(value): void

Parameters

Parameter	Type
value	T

Returns

void

Example

tsx

---

useRealm

useRealm(): Realm

Returns a direct reference to the current realm. Use with caution.

If possible, design your logic in a reactive manner, and use useCellValue and usePublisher to access the output of the realm.

Returns

Realm

---

withLatestFrom

Call Signature

withLatestFrom<I, T1>(…nodes): (source) => NodeRef<[I, T1]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1

Parameters

Parameter	Type
…nodes	[Out<T1>]

Returns

(source): NodeRef<[I, T1]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1]>

Call Signature

withLatestFrom<I, T1, T2>(…nodes): (source) => NodeRef<[I, T1, T2]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>]

Returns

(source): NodeRef<[I, T1, T2]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2]>

Call Signature

withLatestFrom<I, T1, T2, T3>(…nodes): (source) => NodeRef<[I, T1, T2, T3]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2
T3

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>]

Returns

(source): NodeRef<[I, T1, T2, T3]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2, T3]>

Call Signature

withLatestFrom<I, T1, T2, T3, T4>(…nodes): (source) => NodeRef<[I, T1, T2, T3, T4]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2
T3
T4

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>]

Returns

(source): NodeRef<[I, T1, T2, T3, T4]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2, T3, T4]>

Call Signature

withLatestFrom<I, T1, T2, T3, T4, T5>(…nodes): (source) => NodeRef<[I, T1, T2, T3, T4, T5]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2
T3
T4
T5

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>]

Returns

(source): NodeRef<[I, T1, T2, T3, T4, T5]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2, T3, T4, T5]>

Call Signature

withLatestFrom<I, T1, T2, T3, T4, T5, T6>(…nodes): (source) => NodeRef<[I, T1, T2, T3, T4, T5, T6]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2
T3
T4
T5
T6

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>]

Returns

(source): NodeRef<[I, T1, T2, T3, T4, T5, T6]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2, T3, T4, T5, T6]>

Call Signature

withLatestFrom<I, T1, T2, T3, T4, T5, T6, T7>(…nodes): (source) => NodeRef<[I, T1, T2, T3, T4, T5, T6, T7]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2
T3
T4
T5
T6
T7

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>]

Returns

(source): NodeRef<[I, T1, T2, T3, T4, T5, T6, T7]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2, T3, T4, T5, T6, T7]>

Call Signature

withLatestFrom<I, T1, T2, T3, T4, T5, T6, T7, T8>(…nodes): (source) => NodeRef<[I, T1, T2, T3, T4, T5, T6, T7, T8]>

Pulls the latest values from the passed nodes. Note: The operator does not emit when the nodes emit. If you want to get that, use the combine function.

Type Parameters

Type Parameter
I
T1
T2
T3
T4
T5
T6
T7
T8

Parameters

Parameter	Type
…nodes	[Out<T1>, Out<T2>, Out<T3>, Out<T4>, Out<T5>, Out<T6>, Out<T7>, Out<T8>]

Returns

(source): NodeRef<[I, T1, T2, T3, T4, T5, T6, T7, T8]>

Parameters

Parameter	Type
source	Out<I>

Returns

NodeRef<[I, T1, T2, T3, T4, T5, T6, T7, T8]>