@reactivex/rxjs
Version:
Reactive Extensions for modern JavaScript
272 lines (262 loc) • 17.7 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../../">
<title data-ice="title">spec-js/operators/sample-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/sample-spec.js</h1>
<pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">"use strict";
var Rx = require('../../dist/cjs/Rx');
var chai_1 = require('chai');
var Observable = Rx.Observable;
/** @test {sample} */
describe('Observable.prototype.sample', function () {
asDiagram('sample')('should get samples when the notifier emits', function () {
var e1 = hot('---a----b---c----------d-----| ');
var e1subs = '^ ! ';
var e2 = hot('-----x----------x---x------x---|');
var e2subs = '^ ! ';
var expected = '-----a----------c----------d-| ';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should sample nothing if source has not nexted at all', function () {
var e1 = hot('----a-^------------|');
var e1subs = '^ !';
var e2 = hot('-----x-------|');
var e2subs = '^ !';
var expected = '-------------|';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should behave properly when notified by the same observable as the source (issue #2075)', function () {
var item$ = new Rx.Subject();
var results = [];
item$
.sample(item$)
.subscribe(function (value) { return results.push(value); });
item$.next(1);
item$.next(2);
item$.next(3);
chai_1.expect(results).to.deep.equal([1, 2, 3]);
});
it('should sample nothing if source has nexted after all notifications, but notifier does not complete', function () {
var e1 = hot('----a-^------b-----|');
var e1subs = '^ !';
var e2 = hot('-----x--------');
var e2subs = '^ !';
var expected = '-------------|';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should sample when the notifier completes', function () {
var e1 = hot('----a-^------b----------|');
var e1subs = '^ !';
var e2 = hot('-----x-----|');
var e2subs = '^ !';
var expected = '-----------b------|';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should not complete when the notifier completes, nor should it emit', function () {
var e1 = hot('----a----b----c----d----e----f----');
var e1subs = '^ ';
var e2 = hot('------x-| ');
var e2subs = '^ ! ';
var expected = '------a---------------------------';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should complete only when the source completes, if notifier completes early', function () {
var e1 = hot('----a----b----c----d----e----f---|');
var e1subs = '^ !';
var e2 = hot('------x-| ');
var e2subs = '^ ! ';
var expected = '------a--------------------------|';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should allow unsubscribing explicitly and early', function () {
var e1 = hot('----a-^--b----c----d----e----f----| ');
var unsub = ' ! ';
var e1subs = '^ ! ';
var e2 = hot('-----x----------x----------x----------|');
var e2subs = '^ ! ';
var expected = '-----b--------- ';
expectObservable(e1.sample(e2), unsub).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should not break unsubscription chains when result is unsubscribed explicitly', function () {
var e1 = hot('----a-^--b----c----d----e----f----| ');
var e1subs = '^ ! ';
var e2 = hot('-----x----------x----------x----------|');
var e2subs = '^ ! ';
var expected = '-----b--------- ';
var unsub = ' ! ';
var result = e1
.mergeMap(function (x) { return Observable.of(x); })
.sample(e2)
.mergeMap(function (x) { return Observable.of(x); });
expectObservable(result, unsub).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should only sample when a new value arrives, even if it is the same value', function () {
var e1 = hot('----a----b----c----c----e----f----| ');
var e1subs = '^ ! ';
var e2 = hot('------x-x------xx-x---x----x--------|');
var e2subs = '^ ! ';
var expected = '------a--------c------c----e------| ';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should raise error if source raises error', function () {
var e1 = hot('----a-^--b----c----d----# ');
var e1subs = '^ ! ';
var e2 = hot('-----x----------x----------x----------|');
var e2subs = '^ ! ';
var expected = '-----b----------d-# ';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should completes if source does not emits', function () {
var e1 = hot('|');
var e2 = hot('------x-------|');
var expected = '|';
var e1subs = '(^!)';
var e2subs = '(^!)';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should raise error if source throws immediately', function () {
var e1 = hot('#');
var e2 = hot('------x-------|');
var expected = '#';
var e1subs = '(^!)';
var e2subs = '(^!)';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should raise error if notification raises error', function () {
var e1 = hot('--a-----|');
var e2 = hot('----#');
var expected = '----#';
var e1subs = '^ !';
var e2subs = '^ !';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should not completes if source does not complete', function () {
var e1 = hot('-');
var e1subs = '^ ';
var e2 = hot('------x-------|');
var e2subs = '^ !';
var expected = '-';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should sample only until source completes', function () {
var e1 = hot('----a----b----c----d-|');
var e1subs = '^ !';
var e2 = hot('-----------x----------x------------|');
var e2subs = '^ !';
var expected = '-----------b---------|';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
it('should complete sampling if sample observable completes', function () {
var e1 = hot('----a----b----c----d-|');
var e1subs = '^ !';
var e2 = hot('|');
var e2subs = '(^!)';
var expected = '---------------------|';
expectObservable(e1.sample(e2)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
expectSubscriptions(e2.subscriptions).toBe(e2subs);
});
});
//# sourceMappingURL=sample-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>