UNPKG

@reactivex/rxjs

Version:

Reactive Extensions for modern JavaScript

294 lines (284 loc) 17 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">spec-js/operators/scan-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/scan-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; /** @test {scan} */ describe(&apos;Observable.prototype.scan&apos;, function () { asDiagram(&apos;scan((acc, curr) =&gt; acc + curr, 0)&apos;)(&apos;should scan&apos;, function () { var values = { a: 1, b: 3, c: 5, x: 1, y: 4, z: 9 }; var e1 = hot(&apos;--a--b--c--|&apos;, values); var e1subs = &apos;^ !&apos;; var expected = &apos;--x--y--z--|&apos;; var scanFunction = function (o, x) { return o + x; }; expectObservable(e1.scan(scanFunction, 0)).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should scan things&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--e--f--g--|&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;---u--v--w--x--y--z--|&apos;; var values = { u: [&apos;b&apos;], v: [&apos;b&apos;, &apos;c&apos;], w: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;], x: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;], y: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;], z: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;, &apos;g&apos;] }; var source = e1.scan(function (acc, x) { return [].concat(acc, x); }, []); expectObservable(source).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should scan with a seed of undefined&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--e--f--g--|&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;---u--v--w--x--y--z--|&apos;; var values = { u: &apos;undefined b&apos;, v: &apos;undefined b c&apos;, w: &apos;undefined b c d&apos;, x: &apos;undefined b c d e&apos;, y: &apos;undefined b c d e f&apos;, z: &apos;undefined b c d e f g&apos; }; var source = e1.scan(function (acc, x) { return acc + &apos; &apos; + x; }, undefined); expectObservable(source).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should scan without seed&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--|&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;---x--y--z--|&apos;; var values = { x: &apos;b&apos;, y: &apos;bc&apos;, z: &apos;bcd&apos; }; var source = e1.scan(function (acc, x) { return acc + x; }); expectObservable(source).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should handle errors&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--#&apos;); var e1subs = &apos;^ !&apos;; var expected = &apos;---u--v--w--#&apos;; var values = { u: [&apos;b&apos;], v: [&apos;b&apos;, &apos;c&apos;], w: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;] }; var source = e1.scan(function (acc, x) { return [].concat(acc, x); }, []); expectObservable(source).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should handle errors in the projection function&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--e--f--g--|&apos;); var e1subs = &apos;^ ! &apos;; var expected = &apos;---u--v--# &apos;; var values = { u: [&apos;b&apos;], v: [&apos;b&apos;, &apos;c&apos;], w: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;], x: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;], y: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;], z: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;, &apos;g&apos;] }; var source = e1.scan(function (acc, x) { if (x === &apos;d&apos;) { throw &apos;bad!&apos;; } return [].concat(acc, x); }, []); expectObservable(source).toBe(expected, values, &apos;bad!&apos;); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;handle empty&apos;, function () { var e1 = cold(&apos;|&apos;); var e1subs = &apos;(^!)&apos;; var expected = &apos;|&apos;; var source = e1.scan(function (acc, x) { return [].concat(acc, x); }, []); expectObservable(source).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;handle never&apos;, function () { var e1 = cold(&apos;-&apos;); var e1subs = &apos;^&apos;; var expected = &apos;-&apos;; var source = e1.scan(function (acc, x) { return [].concat(acc, x); }, []); expectObservable(source).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;handle throw&apos;, function () { var e1 = cold(&apos;#&apos;); var e1subs = &apos;(^!)&apos;; var expected = &apos;#&apos;; var source = e1.scan(function (acc, x) { return [].concat(acc, x); }, []); expectObservable(source).toBe(expected); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should allow unsubscribing explicitly and early&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--e--f--g--|&apos;); var unsub = &apos; ! &apos;; var e1subs = &apos;^ ! &apos;; var expected = &apos;---u--v--w--x-- &apos;; var values = { u: [&apos;b&apos;], v: [&apos;b&apos;, &apos;c&apos;], w: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;], x: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;], y: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;], z: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;, &apos;g&apos;] }; var source = e1.scan(function (acc, x) { return [].concat(acc, x); }, []); expectObservable(source, unsub).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should not break unsubscription chains when result is unsubscribed explicitly&apos;, function () { var e1 = hot(&apos;--a--^--b--c--d--e--f--g--|&apos;); var e1subs = &apos;^ ! &apos;; var expected = &apos;---u--v--w--x-- &apos;; var unsub = &apos; ! &apos;; var values = { u: [&apos;b&apos;], v: [&apos;b&apos;, &apos;c&apos;], w: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;], x: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;], y: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;], z: [&apos;b&apos;, &apos;c&apos;, &apos;d&apos;, &apos;e&apos;, &apos;f&apos;, &apos;g&apos;] }; var source = e1 .mergeMap(function (x) { return Observable.of(x); }) .scan(function (acc, x) { return [].concat(acc, x); }, []) .mergeMap(function (x) { return Observable.of(x); }); expectObservable(source, unsub).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should pass current index to accumulator&apos;, function () { var values = { a: 1, b: 3, c: 5, x: 1, y: 4, z: 9 }; var idx = [0, 1, 2]; var e1 = hot(&apos;--a--b--c--|&apos;, values); var e1subs = &apos;^ !&apos;; var expected = &apos;--x--y--z--|&apos;; var scanFunction = function (o, value, index) { chai_1.expect(index).to.equal(idx.shift()); return o + value; }; var scan = e1.scan(scanFunction, 0).finally(function () { chai_1.expect(idx).to.be.empty; }); expectObservable(scan).toBe(expected, values); expectSubscriptions(e1.subscriptions).toBe(e1subs); }); it(&apos;should accept array typed reducers&apos;, function () { type(function () { var a; a.reduce(function (acc, value) { return acc.concat(value); }, []); }); }); it(&apos;should accept T typed reducers&apos;, function () { type(function () { var a; a.reduce(function (acc, value) { value.a = acc.a; value.b = acc.b; return acc; }, {}); }); }); it(&apos;should accept R typed reducers&apos;, function () { type(function () { var a; a.reduce(function (acc, value) { value.a = acc.a; value.b = acc.b; return acc; }, {}); }); }); }); //# sourceMappingURL=scan-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>