Streams.Observable Class
Extends Streams.Stream
Defined in:
samsara/streams/Observable.js:8
An Observable is a stream for events set discretely in time, as opposed to continuously.
It emits appropriate start
and end
events upon calling the set
method.
Constructor
Streams.Observable
(
private
-
value
Parameters:
-
value
Number, String, Array, ObjectValue
Methods
filter
(
SimpleStream
-
filterFn
Filter converts the current stream into a new stream
that only emits if the filter condition is satisfied.
The filter function should return a Boolean value.
Parameters:
-
filterFn
FunctionFunction to filter event payload
Returns:
SimpleStream:
stream Filtered stream
get
()
Number, String, Array, Object
Getter for the provided value.
Returns:
Number, String, Array, Object:
map
(
SimpleStream
-
mapperFn
Map converts the current stream into a new stream
with a modified (mapped) data payload.
Parameters:
-
mapperFn
FunctionFunction to map event payload
Returns:
SimpleStream:
stream Mapped stream
pluck
(
SimpleStream
-
key
Pluck is an opinionated mapper. It projects a Stream
onto one of its return values.
Useful if a Stream returns an array or object.
Returns:
SimpleStream:
stream Plucked stream
set
(
-
value
Setter for the provided value.
Parameters:
-
value
Number, String, Array, ObjectValue
split
(
-
splitterFn
Split maps one of several streams based on custom logic.
The splitter function should return an EventEmitter type.
Parameters:
-
splitterFn
FunctionSplitter function