throw.md

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

Ⓢ

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

There is an alias to this method called throwException for browsers <IE9.

Arguments

1. dueTime (Any): Absolute (specified as a Date object) or relative time (specified as an integer denoting milliseconds) at which to produce the first value.
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/linq/observable/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