Variable

A unit of work to be executed in a Scheduler. An action is typically created from within a Scheduler and an RxJS user does not need to concern themselves about creating and manipulating an Action.

class Action<T> extends Subscription {
  new (scheduler: Scheduler, work: (state?: T) => void);
  schedule(state?: T, delay: number = 0): Subscription;
}

A normalized AJAX error.

See:

• ajax

A normalized AJAX response.

See:

• ajax

See:

• ajax

An error thrown when an element was queried at a certain index of an Observable, but no such index or position exists in that sequence.

See:

• elementAt
• take
• takeLast

Test:

• AsyncSubject

Test:

• BehaviorSubject

An error thrown when an Observable or a sequence was queried but has no elements.

See:

• first
• last
• single

An Observable representing values belonging to the same group represented by a common key. The values emitted by a GroupedObservable come from the source Observable. The common key is available as the field key on a GroupedObservable instance.

Represents a push-based event or value that an Observable can emit. This class is particularly useful for operators that manage notifications, like materialize, dematerialize, observeOn, and others. Besides wrapping the actual delivered value, it also annotates it with metadata of, for instance, what type of push message it is (next, error, or complete).

Test:

• Notification

See:

• materialize
• dematerialize
• observeOn

An error thrown when an action is invalid because the object has been unsubscribed.

See:

• Subject
• BehaviorSubject

A representation of any set of values over any amount of time. This the most basic building block of RxJS.

Test:

• Observable
• Observable.create
• Observable.lift

Test:

• ReplaySubject

An execution context and a data structure to order tasks and schedule their execution. Provides a notion of (potentially virtual) time, through the now() getter method.

Each unit of work in a Scheduler is called an Action.

class Scheduler {
  now(): number;
  schedule(work, delay?, state?): Subscription;
}

Test:

• Scheduler.animationFrame
• Scheduler.asap
• Scheduler.queue
• Scheduler.queue

Test:

• Subject

Implements the Observer interface and extends the Subscription class. While the Observer is the public API for consuming the values of an Observable, all Observers get converted to a Subscriber, in order to provide Subscription-like capabilities such as unsubscribe. Subscriber is a common type in RxJS, and crucial for implementing operators, but it is rarely used as a public API.

Test:

• Subscriber

Represents a disposable resource, such as the execution of an Observable. A Subscription has one important method, unsubscribe, that takes no argument and just disposes the resource held by the subscription.

Additionally, subscriptions may be grouped together through the add() method, which will attach a child Subscription to the current Subscription. When a Subscription is unsubscribed, all its children (and its grandchildren) will be unsubscribed as well.

Test:

• Subscription

An error thrown when duetime elapses.

See:

• timeout

An error thrown when one or more errors have occurred during the unsubscribe of a Subscription.

Test:

• UnsubscriptionError

window: browser in DOM main thread self: browser in WebWorker global: Node.js/other

Test:

• root