subscribe.md

This is RxJS v 4. Find the latest version here

Rx.Observable.prototype.subscribe([observer] | [onNext], [onError], [onCompleted])

Rx.Observable.prototype.forEach([observer] | [onNext], [onError], [onCompleted])

Ⓢ

Subscribes an observer to the observable sequence.

Arguments

1. [observer] (Observer): The object that is to receive notifications.
2. [onNext] (Function): Function to invoke for each element in the observable sequence.
3. [onError] (Function): Function to invoke upon exceptional termination of the observable sequence.
4. [onCompleted] (Function): Function to invoke upon graceful termination of the observable sequence.

Returns

(Disposable): The source sequence whose subscriptions and unsubscriptions happen on the specified scheduler.

Example

/* With no arguments */
var source = Rx.Observable.range(0, 3)
    .do(function (x) { console.log('Do Next: ' + x); });

var subscription = source.subscribe();

// => Do Next: 0
// => Do Next: 1
// => Do Next: 2

/* With an observer */
var observer = Rx.Observer.create(
  function (x) {
    console.log('Next: %s', x);
  },
  function (err) {
    console.log('Error: %s', err);
  },
  function () {
    console.log('Completed');
  });

var source = Rx.Observable.range(0, 3)

var subscription = source.subscribe(observer);

// => Next: 0
// => Next: 1
// => Next: 2

/* Using functions */
var source = Rx.Observable.range(0, 3)

var subscription = source.subscribe(
  function (x) {
    console.log('Next: %s', x);
  },
  function (err) {
    console.log('Error: %s', err);
  },
  function () {
    console.log('Completed');
  });

// => Next: 0
// => Next: 1
// => Next: 2

Location

File:

• /src/core/observable.js

Dist:

• rx.all.js
• rx.all.compat.js
• rx.js
• rx.compat.js
• rx.lite.js
• rx.lite.compat.js

NPM Packages:

• rx

NuGet Packages:

• RxJS-All
• RxJS-Main
• RxJS-Lite

Unit Tests:

• /tests/core/observable.js