UNPKG

@reactivex/rxjs

Version:

Reactive Extensions for modern JavaScript

273 lines (263 loc) 14.5 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">spec-js/operators/do-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/do-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 Observable = Rx.Observable; var Subject = Rx.Subject; /** @test {do} */ describe(&apos;Observable.prototype.do&apos;, function () { asDiagram(&apos;do(x =&gt; console.log(x))&apos;)(&apos;should mirror multiple values and complete&apos;, function () { var e1 = cold(&apos;--1--2--3--|&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;--1--2--3--|&apos;; var result = e1.do(function () { //noop }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should next with a callback&apos;, function () { var value = null; Observable.of(42).do(function (x) { value = x; }) .subscribe(); chai_1.expect(value).to.equal(42); }); it(&apos;should error with a callback&apos;, function () { var err = null; Observable.throw(&apos;bad&apos;).do(null, function (x) { err = x; }) .subscribe(null, function (ex) { chai_1.expect(ex).to.equal(&apos;bad&apos;); }); chai_1.expect(err).to.equal(&apos;bad&apos;); }); it(&apos;should handle everything with an observer&apos;, function (done) { var expected = [1, 2, 3]; var results = []; Observable.of(1, 2, 3) .do({ next: function (x) { results.push(x); }, error: function (err) { done(new Error(&apos;should not be called&apos;)); }, complete: function () { chai_1.expect(results).to.deep.equal(expected); done(); } }).subscribe(); }); it(&apos;should handle everything with a Subject&apos;, function (done) { var expected = [1, 2, 3]; var results = []; var subject = new Subject(); subject.subscribe({ next: function (x) { results.push(x); }, error: function (err) { done(new Error(&apos;should not be called&apos;)); }, complete: function () { chai_1.expect(results).to.deep.equal(expected); done(); } }); Observable.of(1, 2, 3) .do(subject) .subscribe(); }); it(&apos;should handle an error with a callback&apos;, function () { var errored = false; Observable.throw(&apos;bad&apos;).do(null, function (err) { chai_1.expect(err).to.equal(&apos;bad&apos;); }) .subscribe(null, function (err) { errored = true; chai_1.expect(err).to.equal(&apos;bad&apos;); }); chai_1.expect(errored).to.be.true; }); it(&apos;should handle an error with observer&apos;, function () { var errored = false; Observable.throw(&apos;bad&apos;).do({ error: function (err) { chai_1.expect(err).to.equal(&apos;bad&apos;); } }) .subscribe(null, function (err) { errored = true; chai_1.expect(err).to.equal(&apos;bad&apos;); }); chai_1.expect(errored).to.be.true; }); it(&apos;should handle complete with observer&apos;, function () { var completed = false; Observable.empty().do({ complete: function () { completed = true; } }).subscribe(); chai_1.expect(completed).to.be.true; }); it(&apos;should handle next with observer&apos;, function () { var value = null; Observable.of(&apos;hi&apos;).do({ next: function (x) { value = x; } }).subscribe(); chai_1.expect(value).to.equal(&apos;hi&apos;); }); it(&apos;should raise error if next handler raises error&apos;, function () { Observable.of(&apos;hi&apos;).do({ next: function (x) { throw new Error(&apos;bad&apos;); } }).subscribe(null, function (err) { chai_1.expect(err.message).to.equal(&apos;bad&apos;); }); }); it(&apos;should raise error if error handler raises error&apos;, function () { Observable.throw(&apos;ops&apos;).do({ error: function (x) { throw new Error(&apos;bad&apos;); } }).subscribe(null, function (err) { chai_1.expect(err.message).to.equal(&apos;bad&apos;); }); }); it(&apos;should raise error if complete handler raises error&apos;, function () { Observable.empty().do({ complete: function () { throw new Error(&apos;bad&apos;); } }).subscribe(null, function (err) { chai_1.expect(err.message).to.equal(&apos;bad&apos;); }); }); it(&apos;should allow unsubscribing explicitly and early&apos;, function () { var e1 = hot(&apos;--1--2--3--#&apos;); var unsub = &apos; ! &apos;; var e1subs = &apos;^ ! &apos;; var expected = &apos;--1--2-- &apos;; var result = e1.do(function () { //noop }); expectObservable(result, unsub).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should not break unsubscription chains when result is unsubscribed explicitly&apos;, function () { var e1 = hot(&apos;--1--2--3--#&apos;); var e1subs = &apos;^ ! &apos;; var expected = &apos;--1--2-- &apos;; var unsub = &apos; ! &apos;; var result = e1 .mergeMap(function (x) { return Observable.of(x); }) .do(function () { //noop }) .mergeMap(function (x) { return Observable.of(x); }); expectObservable(result, unsub).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should mirror multiple values and complete&apos;, function () { var e1 = cold(&apos;--1--2--3--|&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;--1--2--3--|&apos;; var result = e1.do(function () { //noop }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should mirror multiple values and terminate with error&apos;, function () { var e1 = cold(&apos;--1--2--3--#&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;--1--2--3--#&apos;; var result = e1.do(function () { //noop }); expectObservable(result).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); }); //# sourceMappingURL=do-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>