@reactivex/rxjs
Version:
Reactive Extensions for modern JavaScript
266 lines (256 loc) • 16 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../../">
<title data-ice="title">spec-js/operators/first-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/first-spec.js</h1>
<pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">"use strict";
var chai_1 = require('chai');
var Rx = require('../../dist/cjs/Rx');
var Observable = Rx.Observable;
/** @test {first} */
describe('Observable.prototype.first', function () {
asDiagram('first')('should take the first value of an observable with many values', function () {
var e1 = hot('-----a--b--c---d---|');
var expected = '-----(a|) ';
var sub = '^ ! ';
expectObservable(e1.first()).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should take the first value of an observable with one value', function () {
var e1 = hot('---(a|)');
var expected = '---(a|)';
var sub = '^ !';
expectObservable(e1.first()).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should error on empty', function () {
var e1 = hot('--a--^----|');
var expected = '-----#';
var sub = '^ !';
expectObservable(e1.first()).toBe(expected, null, new Rx.EmptyError());
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should return the default value if source observable was empty', function () {
var e1 = hot('-----^----|');
var expected = '-----(a|)';
var sub = '^ !';
expectObservable(e1.first(null, null, 'a')).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should only emit one value in recursive cases', function () {
var subject = new Rx.Subject();
var results = [];
subject.first().subscribe(function (x) {
results.push(x);
subject.next(x + 1);
});
subject.next(0);
chai_1.expect(results).to.deep.equal([0]);
});
it('should propagate error from the source observable', function () {
var e1 = hot('---^---#');
var expected = '----#';
var sub = '^ !';
expectObservable(e1.first()).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should go on forever on never', function () {
var e1 = hot('--^-------');
var expected = '--------';
var sub = '^ ';
expectObservable(e1.first()).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should allow unsubscribing early and explicitly', function () {
var e1 = hot('--a--^-----b----c---d--|');
var e1subs = '^ ! ';
var expected = '---- ';
var unsub = ' ! ';
expectObservable(e1.first(), unsub).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
});
it('should not break unsubscription chains when result is unsubscribed explicitly', function () {
var e1 = hot('--a--^-----b----c---d--|');
var e1subs = '^ ! ';
var expected = '---- ';
var unsub = ' ! ';
var result = e1
.mergeMap(function (x) { return Observable.of(x); })
.first()
.mergeMap(function (x) { return Observable.of(x); });
expectObservable(result, unsub).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(e1subs);
});
it('should return first value that matches a predicate', function () {
var e1 = hot('--a-^--b--c--a--c--|');
var expected = '------(c|)';
var sub = '^ !';
var predicate = function (value) {
return value === 'c';
};
expectObservable(e1.first(predicate)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should return first value that matches a predicate for odd numbers', function () {
var e1 = hot('--a-^--b--c--d--e--|', { a: 1, b: 2, c: 3, d: 4, e: 5 });
var expected = '------(c|)';
var sub = '^ !';
var predicate = function (value) {
return value % 2 === 1;
};
expectObservable(e1.first(predicate)).toBe(expected, { c: 3 });
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should error when no value matches the predicate', function () {
var e1 = hot('--a-^--b--c--a--c--|');
var expected = '---------------#';
var sub = '^ !';
var predicate = function (value) {
return value === 's';
};
expectObservable(e1.first(predicate)).toBe(expected, null, new Rx.EmptyError());
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should return the default value when no value matches the predicate', function () {
var e1 = hot('--a-^--b--c--a--c--|');
var expected = '---------------(d|)';
var sub = '^ !';
var predicate = function (value) {
return value === 's';
};
expectObservable(e1.first(predicate, null, 'd')).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should propagate error when no value matches the predicate', function () {
var e1 = hot('--a-^--b--c--a--#');
var expected = '------------#';
var sub = '^ !';
var predicate = function (value) {
return value === 's';
};
expectObservable(e1.first(predicate)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should return first value that matches the index in the predicate', function () {
var e1 = hot('--a-^--b--c--a--c--|');
var expected = '---------(a|)';
var sub = '^ !';
var predicate = function (value, index) {
return index === 2;
};
expectObservable(e1.first(predicate)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should propagate error from predicate', function () {
var e1 = hot('--a-^--b--c--d--e--|', { a: 1, b: 2, c: 3, d: 4, e: 5 });
var expected = '---------#';
var sub = '^ !';
var predicate = function (value) {
if (value < 4) {
return false;
}
else {
throw 'error';
}
};
expectObservable(e1.first(predicate)).toBe(expected, null, 'error');
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should support a result selector argument', function () {
var e1 = hot('--a--^---b---c---d---e--|');
var expected = '--------(x|)';
var sub = '^ !';
var predicate = function (x) { return x === 'c'; };
var resultSelector = function (x, i) {
chai_1.expect(i).to.equal(1);
chai_1.expect(x).to.equal('c');
return 'x';
};
expectObservable(e1.first(predicate, resultSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
it('should raise error when result selector throws', function () {
var e1 = hot('--a--^---b---c---d---e--|');
var expected = '--------#';
var sub = '^ !';
var predicate = function (x) { return x === 'c'; };
var resultSelector = function (x, i) {
throw 'error';
};
expectObservable(e1.first(predicate, resultSelector)).toBe(expected);
expectSubscriptions(e1.subscriptions).toBe(sub);
});
});
//# sourceMappingURL=first-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>