Airstream
API
Generated with
Airstream/com.raquo.airstream/com.raquo.airstream.core

com.raquo.airstream.core

package com.raquo.airstream.core

Members list

Type members

Classlikes

sealed abstract class AirstreamError(message: String) extends Throwable

Attributes

Companion
object
Supertypes
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class DebugError
class VarError
Show all
object AirstreamError

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
trait BaseObservable[+Self <: (Observable), +A] extends Source[A], Named

This trait represents a reactive value that can be subscribed to.

This trait represents a reactive value that can be subscribed to.

It has only one direct subtype, Observable, which in turn has two direct subtypes, EventStream and Signal.

BaseObservable is the same as Observable, it just lives in a separate trait for technical reasons (the Self type param).

All Observables are lazy. An Observable starts when it gets its first observer (internal or external), and stops when it loses its last observer (again, internal or external).

Basic idea: Lazy Observable only holds references to those children that have any observers (either directly on themselves, or on any of their descendants). What this achieves:

  • Stream only propagates its value to children that (directly or not) have observers
  • Stream calculates its value only once regardless of how many observers / children it has) (so, all streams are "hot" observables)
  • Stream doesn't hold references to Streams that no one observes, allowing those Streams to be garbage collected if they are otherwise unreachable (which they should become when their subscriptions are killed by their owners)

Attributes

Companion
object
Supertypes
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Known subtypes
trait EventStream[A]
trait WritableStream[A]
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
trait Observable[A]
trait Signal[A]
trait WritableSignal[A]
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
trait StrictSignal[A]
trait OwnedSignal[A]
trait SyncObservable[A]
trait CustomSource[A]
Show all
object BaseObservable

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait EventStream[+A] extends Observable[A], BaseObservable[EventStream, A], EventSource[A]

Attributes

Companion
object
Supertypes
trait EventSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait WritableStream[A]
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
Show all
object EventStream

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait InternalObserver[-A]

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class TakeStream[A]
class DelayStream[A]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class DebuggerStream[A]
class DistinctStream[A]
class SwitchSignal[A]
class StreamFromSignal[A]
class DebounceStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
trait SingleParentStream[I, O]
Show all
object InternalObserver

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
trait Named

This trait lets the user set an ad-hoc name for this instance. Used for debugging and tracing.

This trait lets the user set an ad-hoc name for this instance. Used for debugging and tracing.

Subclasses: BaseObservable, Observer

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BaseObservable[Self, A]
trait EventStream[A]
trait WritableStream[A]
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
trait Observable[A]
trait Signal[A]
trait WritableSignal[A]
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
trait StrictSignal[A]
trait OwnedSignal[A]
trait SyncObservable[A]
trait CustomSource[A]
trait Observer[A]
class DebuggerObserver[A]
class WriteBus[A]
class EventBus[A]
trait Var[A]
class DerivedVar[A, B]
class SourceVar[A]
Show all
trait Observable[+A] extends BaseObservable[Observable, A]

All the interesting stuff is in BaseObservable. This trait exists only as a sort of type alias for BaseObservable[Observable, A]. (I can't use an actual type alias for this due to an illegal cycle)

All the interesting stuff is in BaseObservable. This trait exists only as a sort of type alias for BaseObservable[Observable, A]. (I can't use an actual type alias for this due to an illegal cycle)

Attributes

Companion
object
Supertypes
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait EventStream[A]
trait WritableStream[A]
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
trait Signal[A]
trait WritableSignal[A]
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
trait StrictSignal[A]
trait OwnedSignal[A]
trait SyncObservable[A]
trait CustomSource[A]
Show all
object Observable extends ObservableLowPriorityImplicits

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Observable.type
trait ObservableLowPriorityImplicits

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Observable.type
trait Observer[-A] extends Sink[A], Named

Attributes

Companion
object
Supertypes
trait Named
trait Sink[A]
class Object
trait Matchable
class Any
Known subtypes
class DebuggerObserver[A]
class WriteBus[A]
object Observer

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Observer.type
final class ObserverList[Obs](observers: JsArray[Obs]) extends AnyVal

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
class Protected

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Protected

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Protected.type
trait Signal[+A] extends Observable[A], BaseObservable[Signal, A], SignalSource[A]

Signal is an Observable with a current value.

Signal is an Observable with a current value.

Attributes

Companion
object
Supertypes
trait SignalSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait WritableSignal[A]
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
trait StrictSignal[A]
trait OwnedSignal[A]
Show all
object Signal

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Signal.type
trait Sink[-A]

A Sink is something that can be converted to an Observer. The counterparty to Sink is a Source, something that can be converted to an Observable.

A Sink is something that can be converted to an Observer. The counterparty to Sink is a Source, something that can be converted to an Observable.

A Sink could be an Observer itself, an EventBus, a Var, or, via implicits, an external type like js.Function1.

The point of using Sink instead of Observer in your API is to let the end users pass simply eventBus instead of eventBus.writer to a method that requires Sink, and to achieve that without having an implicit conversion from EventBus to Observer, because then you'd also want an implicit conversion from EventBus to Observable, and those two would be incompatible (e.g. both Observable and Observer have a filter method).

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Observer[A]
class DebuggerObserver[A]
class WriteBus[A]
class EventBus[A]
trait Var[A]
class DerivedVar[A, B]
class SourceVar[A]
Show all
object Sink

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Sink.type
trait Source[+A]

A Source is something that can be converted to an Observable. The counterparty to Source is a Sink, something that can be converted to an Observer.

A Source is something that can be converted to an Observable. The counterparty to Source is a Sink, something that can be converted to an Observer.

A Source could be an Observable itself, an EventBus, a Var, or, via implicits, a third party type like Future or ZIO.

The point of using Source instead of Observable in your API is to let the end users pass simply eventBus instead of eventBus.events to a method that requires Source, and to achieve that without having an implicit conversion from EventBus to Observable, because then you'd also want an implicit conversion from EventBus to Observer, and those two would be incompatible (e.g. both Observable and Observer have a filter method).

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait BaseObservable[Self, A]
trait EventStream[A]
trait WritableStream[A]
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
trait Observable[A]
trait Signal[A]
trait WritableSignal[A]
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
trait StrictSignal[A]
trait OwnedSignal[A]
trait SyncObservable[A]
trait CustomSource[A]
trait EventSource[A]
class EventBus[A]
trait SignalSource[A]
trait Var[A]
class DerivedVar[A, B]
class SourceVar[A]
Show all
object Source

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Source.type
trait SyncObservable[+A] extends Observable[A]

Observable that can become pending for the purpose of synchronization - see Transaction for pending logic

Observable that can become pending for the purpose of synchronization - see Transaction for pending logic

Attributes

Supertypes
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
class CombineSignalN[A, Out]
class CombineStreamN[A, Out]
class SampleCombineSignalN[A, Out]
class SampleCombineStreamN[A, Out]
class MergeStream[A]
class SyncDelayStream[A]
Show all
class Transaction(var code: Transaction => Any)

Transaction is a moment in time during which Airstream guarantees no FRP glitches.

Transaction is a moment in time during which Airstream guarantees no FRP glitches.

Some observables need to emit their events in new transactions. Roughly speaking:

  • All async observables (e.g. delay(100))
  • All observables that can create loops in the observable graph (e.g. flatMapSwitch)
  • All observables that get their events from outside of Airstream (e.g. custom sources)

An observable can only emit once in a given transaction.

  • See MergeStream or CustomSource for examples of handling that.

See the docs for more details.

Value parameters

code

Note: Must not throw!

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object Transaction

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait WritableObservable[A] extends Observable[A]

Attributes

Supertypes
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait WritableSignal[A]
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
trait WritableStream[A]
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
trait CustomSource[A]
Show all
trait WritableSignal[A] extends Signal[A], WritableObservable[A]

Attributes

Supertypes
trait Signal[A]
trait SignalSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
trait MultiParentSignal[I, O]
class CombineSignalN[A, Out]
class SampleCombineSignalN[A, Out]
trait SingleParentSignal[I, O]
class DebuggerSignal[A]
class DistinctSignal[A]
class MapSignal[I, O]
class DerivedVarSignal[A, B]
class ObservedSignal[A]
class ScanLeftSignal[A, B]
class SignalFromStream[A]
class SplitSignal[M, Input, Output, Key]
class SwitchSignal[A]
class Val[A]
class JsPromiseSignal[A]
Show all
trait WritableStream[A] extends EventStream[A], WritableObservable[A]

Attributes

Supertypes
trait EventStream[A]
trait EventSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Known subtypes
class MergeStream[A]
trait MultiParentStream[I, O]
class CombineStreamN[A, Out]
class SampleCombineStreamN[A, Out]
trait SingleParentStream[I, O]
class DebuggerStream[A]
class DistinctStream[A]
class CollectStream[A, B]
class DropStream[A]
class FilterStream[A]
class MapStream[I, O]
class StreamFromSignal[A]
class TakeStream[A]
class DebounceStream[A]
class DelayStream[A]
class SyncDelayStream[A]
class ThrottleStream[A]
class EventBusStream[A]
class ConcurrentStream[A]
class SwitchStream[I, O]
class JsPromiseStream[A]
class PeriodicStream[A]
class AjaxStream
class FetchStream
Show all
Generated with