UNPKG

@reactivex/rxjs

Version:

Reactive Extensions for modern JavaScript

230 lines (220 loc) 14.2 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">spec-js/operators/pluck-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/pluck-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 {pluck} */ describe(&apos;Observable.prototype.pluck&apos;, function () { asDiagram(&apos;pluck(\&apos;v\&apos;)&apos;)(&apos;should dematerialize an Observable&apos;, function () { var values = { a: &apos;{v:1}&apos;, b: &apos;{v:2}&apos;, c: &apos;{v:3}&apos; }; var e1 = cold(&apos;--a--b--c--|&apos;, values); var expected = &apos;--x--y--z--|&apos;; var result = e1.map(function (x) { return ({ v: x.charAt(3) }); }).pluck(&apos;v&apos;); expectObservable(result).toBe(expected, { x: &apos;1&apos;, y: &apos;2&apos;, z: &apos;3&apos; }); }); it(&apos;should work for one object&apos;, function () { var a = cold(&apos;--x--|&apos;, { x: { prop: 42 } }); var asubs = &apos;^ !&apos;; var expected = &apos;--y--|&apos;; var r = a.pluck(&apos;prop&apos;); expectObservable(r).toBe(expected, { y: 42 }); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should work for multiple objects&apos;, function () { var inputs = { a: { prop: &apos;1&apos; }, b: { prop: &apos;2&apos; }, c: { prop: &apos;3&apos; }, d: { prop: &apos;4&apos; }, e: { prop: &apos;5&apos; }, }; var a = cold(&apos;--a-b--c-d---e-|&apos;, inputs); var asubs = &apos;^ !&apos;; var expected = &apos;--1-2--3-4---5-|&apos;; var r = a.pluck(&apos;prop&apos;); expectObservable(r).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should work with deep nested properties&apos;, function () { var inputs = { a: { a: { b: { c: &apos;1&apos; } } }, b: { a: { b: { c: &apos;2&apos; } } }, c: { a: { b: { c: &apos;3&apos; } } }, d: { a: { b: { c: &apos;4&apos; } } }, e: { a: { b: { c: &apos;5&apos; } } }, }; var a = cold(&apos;--a-b--c-d---e-|&apos;, inputs); var asubs = &apos;^ !&apos;; var expected = &apos;--1-2--3-4---5-|&apos;; var r = a.pluck(&apos;a&apos;, &apos;b&apos;, &apos;c&apos;); expectObservable(r).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should work with edge cases of deep nested properties&apos;, function () { var inputs = { a: { a: { b: { c: 1 } } }, b: { a: { b: 2 } }, c: { a: { c: { c: 3 } } }, d: {}, e: { a: { b: { c: 5 } } }, }; var a = cold(&apos;--a-b--c-d---e-|&apos;, inputs); var asubs = &apos;^ !&apos;; var expected = &apos;--r-x--y-z---w-|&apos;; var values = { r: 1, x: undefined, y: undefined, z: undefined, w: 5 }; var r = a.pluck(&apos;a&apos;, &apos;b&apos;, &apos;c&apos;); expectObservable(r).toBe(expected, values); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should throw an error if not property is passed&apos;, function () { chai_1.expect(function () { Observable.of({ prop: 1 }, { prop: 2 }).pluck(); }).to.throw(Error, &apos;list of properties cannot be empty.&apos;); }); it(&apos;should propagate errors from observable that emits only errors&apos;, function () { var a = cold(&apos;#&apos;); var asubs = &apos;(^!)&apos;; var expected = &apos;#&apos;; var r = a.pluck(&apos;whatever&apos;); expectObservable(r).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should propagate errors from observable that emit values&apos;, function () { var a = cold(&apos;--a--b--#&apos;, { a: { prop: &apos;1&apos; }, b: { prop: &apos;2&apos; } }, &apos;too bad&apos;); var asubs = &apos;^ !&apos;; var expected = &apos;--1--2--#&apos;; var r = a.pluck(&apos;prop&apos;); expectObservable(r).toBe(expected, undefined, &apos;too bad&apos;); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should not pluck an empty observable&apos;, function () { var a = cold(&apos;|&apos;); var asubs = &apos;(^!)&apos;; var expected = &apos;|&apos;; var invoked = 0; var r = a .pluck(&apos;whatever&apos;) .do(null, null, function () { chai_1.expect(invoked).to.equal(0); }); expectObservable(r).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should allow unsubscribing explicitly and early&apos;, function () { var a = cold(&apos;--a--b--c--|&apos;, { a: { prop: &apos;1&apos; }, b: { prop: &apos;2&apos; } }); var unsub = &apos; ! &apos;; var asubs = &apos;^ ! &apos;; var expected = &apos;--1--2- &apos;; var r = a.pluck(&apos;prop&apos;); expectObservable(r, unsub).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should pluck twice&apos;, function () { var inputs = { a: { a: { b: { c: &apos;1&apos; } } }, b: { a: { b: { c: &apos;2&apos; } } }, c: { a: { b: { c: &apos;3&apos; } } }, d: { a: { b: { c: &apos;4&apos; } } }, e: { a: { b: { c: &apos;5&apos; } } }, }; var a = cold(&apos;--a-b--c-d---e-|&apos;, inputs); var asubs = &apos;^ !&apos;; var expected = &apos;--1-2--3-4---5-|&apos;; var r = a.pluck(&apos;a&apos;, &apos;b&apos;).pluck(&apos;c&apos;); expectObservable(r).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); it(&apos;should not break unsubscription chain when unsubscribed explicitly&apos;, function () { var a = cold(&apos;--a--b--c--|&apos;, { a: { prop: &apos;1&apos; }, b: { prop: &apos;2&apos; } }); var unsub = &apos; ! &apos;; var asubs = &apos;^ ! &apos;; var expected = &apos;--1--2- &apos;; var r = a .mergeMap(function (x) { return Observable.of(x); }) .pluck(&apos;prop&apos;) .mergeMap(function (x) { return Observable.of(x); }); expectObservable(r, unsub).toBe(expected); expectSubscriptions(a.subscriptions).toBe(asubs); }); }); //# sourceMappingURL=pluck-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>