UNPKG

@reactivex/rxjs

Version:

Reactive Extensions for modern JavaScript

289 lines (279 loc) 16.7 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">spec-js/operators/catch-spec.js | RxJS API Document</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> <script data-ice="userScript" src="user/script/0-Rx.js"></script> <script data-ice="userScript" src="user/script/1-devtools-welcome.js"></script> <script data-ice="userScript" src="user/script/2-custom-manual-styles.js"></script> <script data-ice="userScript" src="user/script/3-decision-tree-widget.min.js"></script> <script data-ice="userScript" src="user/script/4-theme-toggler.js"></script> <link data-ice="userStyle" rel="stylesheet" href="user/css/0-main.css"> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="./manual/index.html" data-ice="manualHeaderLink">Manual</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a href="test.html" data-ice="testLink">Test</a> <a data-ice="repoURL" href="https://github.com/ReactiveX/RxJS" class="repo-url-github">Repository</a> <div class="search-box"> <span> <img src="./image/search.png"> <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span> </span> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-AsyncSubject">AsyncSubject</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-BehaviorSubject">BehaviorSubject</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Notification">Notification</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Observable">Observable</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-ReplaySubject">ReplaySubject</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Scheduler">Scheduler</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-AnonymousSubject">AnonymousSubject</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Subject">Subject</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-SubjectSubscriber">SubjectSubscriber</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Subscriber">Subscriber</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Subscription">Subscription</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-Rx.Scheduler">Rx.Scheduler</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-typedef">T</span><span data-ice="name"><span><a href="typedef/index.html#static-typedef-Rx.Symbol">Rx.Symbol</a></span></span></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">observable</div><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-ConnectableObservable">ConnectableObservable</a></span></span></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">observable/dom</div><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-AjaxError">AjaxError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-AjaxResponse">AjaxResponse</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-AjaxTimeoutError">AjaxTimeoutError</a></span></span></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">operator</div><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-GroupedObservable">GroupedObservable</a></span></span></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">scheduler</div><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-Action">Action</a></span></span></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">util</div><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-ArgumentOutOfRangeError">ArgumentOutOfRangeError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-EmptyError">EmptyError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-ObjectUnsubscribedError">ObjectUnsubscribedError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-TimeoutError">TimeoutError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-UnsubscriptionError">UnsubscriptionError</a></span></span></li> <li data-ice="doc"><span data-ice="kind" class="kind-variable">V</span><span data-ice="name"><span><a href="variable/index.html#static-variable-root">root</a></span></span></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">spec-js/operators/catch-spec.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">&quot;use strict&quot;; var chai_1 = require(&apos;chai&apos;); var Rx = require(&apos;../../dist/cjs/Rx&apos;); var test_helper_1 = require(&apos;../helpers/test-helper&apos;); var Observable = Rx.Observable; /** @test {catch} */ describe(&apos;Observable.prototype.catch&apos;, function () { asDiagram(&apos;catch&apos;)(&apos;should catch error and replace with a cold Observable&apos;, function () { var e1 = hot(&apos;--a--b--# &apos;); var e2 = cold(&apos;-1-2-3-| &apos;); var expected = &apos;--a--b---1-2-3-|)&apos;; var result = e1.catch(function (err) { return e2; }); expectObservable(result).toBe(expected); }); it(&apos;should catch error and replace it with Observable.of()&apos;, function () { var e1 = hot(&apos;--a--b--c--------|&apos;); var subs = &apos;^ !&apos;; var expected = &apos;--a--b--(XYZ|)&apos;; var result = e1 .map(function (n) { if (n === &apos;c&apos;) { throw &apos;bad&apos;; } return n; }) .catch(function (err) { return Observable.of(&apos;X&apos;, &apos;Y&apos;, &apos;Z&apos;); }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(subs); }); it(&apos;should catch error and replace it with a cold Observable&apos;, function () { var e1 = hot(&apos;--a--b--# &apos;); var e1subs = &apos;^ ! &apos;; var e2 = cold(&apos;1-2-3-4-5-|&apos;); var e2subs = &apos; ^ !&apos;; var expected = &apos;--a--b--1-2-3-4-5-|&apos;; var result = e1.catch(function (err) { return e2; }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); expectSubscriptions(e2.subscriptions).toBe(e2subs); }); it(&apos;should allow unsubscribing explicitly and early&apos;, function () { var e1 = hot(&apos;--1-2-3-4-5-6---#&apos;); var e1subs = &apos;^ ! &apos;; var expected = &apos;--1-2-3- &apos;; var unsub = &apos; ! &apos;; var result = e1.catch(function () { return Observable.of(&apos;X&apos;, &apos;Y&apos;, &apos;Z&apos;); }); expectObservable(result, unsub).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should not break unsubscription chain when unsubscribed explicitly&apos;, function () { var e1 = hot(&apos;--1-2-3-4-5-6---#&apos;); var e1subs = &apos;^ ! &apos;; var expected = &apos;--1-2-3- &apos;; var unsub = &apos; ! &apos;; var result = e1 .mergeMap(function (x) { return Observable.of(x); }) .catch(function () { return Observable.of(&apos;X&apos;, &apos;Y&apos;, &apos;Z&apos;); }) .mergeMap(function (x) { return Observable.of(x); }); expectObservable(result, unsub).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should catch error and replace it with a hot Observable&apos;, function () { var e1 = hot(&apos;--a--b--# &apos;); var e1subs = &apos;^ ! &apos;; var e2 = hot(&apos;1-2-3-4-5-6-7-8-9-|&apos;); var e2subs = &apos; ^ !&apos;; var expected = &apos;--a--b--5-6-7-8-9-|&apos;; var result = e1.catch(function (err) { return e2; }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); expectSubscriptions(e2.subscriptions).toBe(e2subs); }); it(&apos;should catch and allow the cold observable to be repeated with the third &apos; + &apos;(caught) argument&apos;, function () { var e1 = cold(&apos;--a--b--c--------| &apos;); var subs = [&apos;^ ! &apos;, &apos; ^ ! &apos;, &apos; ^ !&apos;]; var expected = &apos;--a--b----a--b----a--b--#&apos;; var retries = 0; var result = e1 .map(function (n) { if (n === &apos;c&apos;) { throw &apos;bad&apos;; } return n; }) .catch(function (err, caught) { if (retries++ === 2) { throw &apos;done&apos;; } return caught; }); expectObservable(result).toBe(expected, undefined, &apos;done&apos;); expectSubscriptions(e1.subscriptions).toBe(subs); }); it(&apos;should catch and allow the hot observable to proceed with the third &apos; + &apos;(caught) argument&apos;, function () { var e1 = hot(&apos;--a--b--c----d---|&apos;); var subs = [&apos;^ ! &apos;, &apos; ^ !&apos;]; var expected = &apos;--a--b-------d---|&apos;; var retries = 0; var result = e1 .map(function (n) { if (n === &apos;c&apos;) { throw &apos;bad&apos;; } return n; }) .catch(function (err, caught) { if (retries++ === 2) { throw &apos;done&apos;; } return caught; }); expectObservable(result).toBe(expected, undefined, &apos;done&apos;); expectSubscriptions(e1.subscriptions).toBe(subs); }); it(&apos;should catch and replace a Observable.throw() as the source&apos;, function () { var e1 = cold(&apos;#&apos;); var subs = &apos;(^!)&apos;; var expected = &apos;(abc|)&apos;; var result = e1.catch(function (err) { return Observable.of(&apos;a&apos;, &apos;b&apos;, &apos;c&apos;); }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(subs); }); it(&apos;should mirror the source if it does not raise errors&apos;, function () { var e1 = cold(&apos;--a--b--c--|&apos;); var subs = &apos;^ !&apos;; var expected = &apos;--a--b--c--|&apos;; var result = e1.catch(function (err) { return Observable.of(&apos;x&apos;, &apos;y&apos;, &apos;z&apos;); }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(subs); }); it(&apos;should complete if you return Observable.empty()&apos;, function () { var e1 = hot(&apos;--a--b--#&apos;); var e1subs = &apos;^ !&apos;; var e2 = cold(&apos;|&apos;); var e2subs = &apos; (^!)&apos;; var expected = &apos;--a--b--|&apos;; var result = e1.catch(function () { return e2; }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); expectSubscriptions(e2.subscriptions).toBe(e2subs); }); it(&apos;should raise error if you return Observable.throw()&apos;, function () { var e1 = hot(&apos;--a--b--#&apos;); var e1subs = &apos;^ !&apos;; var e2 = cold(&apos;#&apos;); var e2subs = &apos; (^!)&apos;; var expected = &apos;--a--b--#&apos;; var result = e1.catch(function () { return e2; }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); expectSubscriptions(e2.subscriptions).toBe(e2subs); }); it(&apos;should never terminate if you return Observable.never()&apos;, function () { var e1 = hot(&apos;--a--b--#&apos;); var e1subs = &apos;^ !&apos;; var e2 = cold(&apos;-&apos;); var e2subs = &apos; ^&apos;; var expected = &apos;--a--b---&apos;; var result = e1.catch(function () { return e2; }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); expectSubscriptions(e2.subscriptions).toBe(e2subs); }); it(&apos;should pass the error as the first argument&apos;, function (done) { Observable.throw(&apos;bad&apos;) .catch(function (err) { chai_1.expect(err).to.equal(&apos;bad&apos;); return Observable.empty(); }) .subscribe(function () { //noop }, function (err) { done(new Error(&apos;should not be called&apos;)); }, function () { done(); }); }); it(&apos;should accept selector returns any ObservableInput&apos;, function (done) { var input$ = test_helper_1.createObservableInputs(42); input$.mergeMap(function (input) { return Observable.throw(&apos;bad&apos;).catch(function (err) { return input; }); }).subscribe(function (x) { chai_1.expect(x).to.be.equal(42); }, function (err) { done(new Error(&apos;should not be called&apos;)); }, function () { done(); }); }); }); //# sourceMappingURL=catch-spec.js.map</code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(0.4.8)</span></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>