Module: "urx/src/actions"

urx Actions operate on streams - publish publishes data in a stream, and subscribe attaches a subscription to a stream.

Index

Interfaces

• Emitter
• Publisher
• StatefulStream
• Stream
• Subscription
• Unsubscribe

Functions

• connect
• getValue
• handleNext
• publish
• reset
• subscribe

Functions

connect

▸ connect<T>(emitter: Emitter<T>, publisher: Publisher<T>): Unsubscribe

Defined in urx/src/actions.ts:132

Connects two streams - any value emitted from the emitter will be published in the publisher.

const foo = stream<number>();

const bar = stream<number>();

subscribe(bar, (value) => console.log(`Bar emitted ${value}`));

connect(foo, bar);

publish(foo);

Type parameters:

Name
T

Parameters:

Name	Type
emitter	Emitter<T>
publisher	Publisher<T>

Returns: Unsubscribe

an Unsubscribe handle which will disconnect the two streams.

---

getValue

▸ getValue<T>(depot: StatefulStream<T>): T

Defined in urx/src/actions.ts:116

Extracts the current value from a stateful stream. Use it only as an escape hatch, as it violates the concept of reactive programming.

const foo = statefulStream(42);

console.log(getValue(foo));

Type parameters:

Name
T

Parameters:

Name	Type
depot	StatefulStream<T>

Returns: T

---

handleNext

▸ handleNext<T>(emitter: Emitter<T>, subscription: Subscription<T>): Unsubscribe

Defined in urx/src/actions.ts:146

Executes the passed subscription at most once, for the next emit from the emitter.

const foo = stream<number>()

handleNext(foo, value => console.log(value)) // called once, with 42

publish(foo, 42)

publish(foo, 43)

Type parameters:

Name
T

Parameters:

Name	Type
emitter	Emitter<T>
subscription	Subscription<T>

Returns: Unsubscribe

an Unsubscribe handle to unbind the subscription if necessary.

---

publish

▸ publish<T>(publisher: Publisher<T>, value: T): void

Defined in urx/src/actions.ts:92

Publishes the value into the passed Publisher.

const foo = stream<number>();

publish(foo, 42);

Type parameters:

Name
T

Parameters:

Name	Type
publisher	Publisher<T>
value	T

Returns: void

---

reset

▸ reset(emitter: Emitter<any>): void

Defined in urx/src/actions.ts:105

Clears all subscriptions from the Emitter.

const foo = stream<number>();

subscribe(foo, (value) => console.log(value));

reset(foo);

publish(foo, 42);

Parameters:

Name	Type
emitter	Emitter<any>

Returns: void

---

subscribe

▸ subscribe<T>(emitter: Emitter<T>, subscription: Subscription<T>): Unsubscribe

Defined in urx/src/actions.ts:80

Subscribes the specified Subscription to the updates from the Emitter. The emitter calls the subscription with the new data each time new data is published into it.

const foo = stream<number>();

subscribe(foo, (value) => console.log(value));

Type parameters:

Name
T

Parameters:

Name	Type
emitter	Emitter<T>
subscription	Subscription<T>

Returns: Unsubscribe

an Unsubscribe handle - calling it will unbind the subscription from the emitter.

const foo = stream<number>();

const unsub = subscribe(foo, (value) => console.log(value));

unsub();