throw.md

This is RxJS v 4. Find the latest version here

Rx.Observable.throw(exception, [scheduler])

Rx.Observable.throwError(exception, [scheduler])

Rx.Observable.throwException(exception, [scheduler]) ** DEPRECATED **

Ⓢ

Returns an observable sequence that terminates with an exception, using the specified scheduler to send out the single onError message.

Arguments

1. exception (Error): Error the observable sequence terminates with.
2. [scheduler=Rx.Scheduler.immediate] (Scheduler): Scheduler to send the exceptional termination call on. If not specified, defaults to the immediate scheduler.

Returns

(Observable): The observable sequence that terminates exceptionally with the specified exception object.

Example

var source = Rx.Observable.return(42)
    .selectMany(Rx.Observable.throw(new Error('error!')));

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

// => Error: Error: error!

Location

File:

• /src/core/perf/operators/throw.js

Dist:

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

Prerequisites:

• 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/observable/throw.js