@reactivex/rxjs
Version:
Reactive Extensions for modern JavaScript
325 lines (315 loc) • 16.1 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../../../">
<title data-ice="title">spec-js/observables/fromEvent-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/observables/fromEvent-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 {fromEvent} */
describe('Observable.fromEvent', function () {
asDiagram('fromEvent(element, \'click\')')('should create an observable of click on the element', function () {
var target = {
addEventListener: function (eventType, listener) {
Observable.timer(50, 20, rxTestScheduler)
.mapTo('ev')
.take(2)
.concat(Observable.never())
.subscribe(listener);
},
removeEventListener: function () { return void 0; },
dispatchEvent: function () { return void 0; },
};
var e1 = Observable.fromEvent(target, 'click');
var expected = '-----x-x---';
expectObservable(e1).toBe(expected, { x: 'ev' });
});
it('should setup an event observable on objects with "on" and "off" ', function () {
var onEventName;
var onHandler;
var offEventName;
var offHandler;
var obj = {
on: function (a, b) {
onEventName = a;
onHandler = b;
},
off: function (a, b) {
offEventName = a;
offHandler = b;
}
};
var subscription = Observable.fromEvent(obj, 'click')
.subscribe(function () {
//noop
});
subscription.unsubscribe();
chai_1.expect(onEventName).to.equal('click');
chai_1.expect(typeof onHandler).to.equal('function');
chai_1.expect(offEventName).to.equal(onEventName);
chai_1.expect(offHandler).to.equal(onHandler);
});
it('should setup an event observable on objects with "addEventListener" and "removeEventListener" ', function () {
var onEventName;
var onHandler;
var offEventName;
var offHandler;
var obj = {
addEventListener: function (a, b, useCapture) {
onEventName = a;
onHandler = b;
},
removeEventListener: function (a, b, useCapture) {
offEventName = a;
offHandler = b;
}
};
var subscription = Observable.fromEvent(obj, 'click')
.subscribe(function () {
//noop
});
subscription.unsubscribe();
chai_1.expect(onEventName).to.equal('click');
chai_1.expect(typeof onHandler).to.equal('function');
chai_1.expect(offEventName).to.equal(onEventName);
chai_1.expect(offHandler).to.equal(onHandler);
});
it('should setup an event observable on objects with "addListener" and "removeListener" ', function () {
var onEventName;
var onHandler;
var offEventName;
var offHandler;
var obj = {
addListener: function (a, b) {
onEventName = a;
onHandler = b;
},
removeListener: function (a, b) {
offEventName = a;
offHandler = b;
}
};
var subscription = Observable.fromEvent(obj, 'click')
.subscribe(function () {
//noop
});
subscription.unsubscribe();
chai_1.expect(onEventName).to.equal('click');
chai_1.expect(typeof onHandler).to.equal('function');
chai_1.expect(offEventName).to.equal(onEventName);
chai_1.expect(offHandler).to.equal(onHandler);
});
it('should error on invalid event targets', function () {
var obj = {
addListener: function () {
//noop
}
};
var subscribe = function () { return Observable.fromEvent(obj, 'click').subscribe(); };
chai_1.expect(subscribe).to.throw(TypeError, 'Invalid event target');
});
it('should pass through options to addEventListener', function () {
var actualOptions;
var expectedOptions = { capture: true, passive: true };
var obj = {
addEventListener: function (a, b, c) {
actualOptions = c;
},
removeEventListener: function (a, b, c) {
//noop
}
};
var subscription = Observable.fromEvent(obj, 'click', expectedOptions)
.subscribe(function () {
//noop
});
subscription.unsubscribe();
chai_1.expect(actualOptions).to.equal(expectedOptions);
});
it('should pass through events that occur', function (done) {
var send;
var obj = {
on: function (name, handler) {
send = handler;
},
off: function () {
//noop
}
};
Observable.fromEvent(obj, 'click').take(1)
.subscribe(function (e) {
chai_1.expect(e).to.equal('test');
}, function (err) {
done(new Error('should not be called'));
}, function () {
done();
});
send('test');
});
it('should pass through events that occur and use the selector if provided', function (done) {
var send;
var obj = {
on: function (name, handler) {
send = handler;
},
off: function () {
//noop
}
};
function selector(x) {
return x + '!';
}
Observable.fromEvent(obj, 'click', selector).take(1)
.subscribe(function (e) {
chai_1.expect(e).to.equal('test!');
}, function (err) {
done(new Error('should not be called'));
}, function () {
done();
});
send('test');
});
it('should not fail if no event arguments are passed and the selector does not return', function (done) {
var send;
var obj = {
on: function (name, handler) {
send = handler;
},
off: function () {
//noop
}
};
function selector() {
//noop
}
Observable.fromEvent(obj, 'click', selector).take(1)
.subscribe(function (e) {
chai_1.expect(e).not.exist;
}, function (err) {
done(new Error('should not be called'));
}, function () {
done();
});
send();
});
it('should return a value from the selector if no event arguments are passed', function (done) {
var send;
var obj = {
on: function (name, handler) {
send = handler;
},
off: function () {
//noop
}
};
function selector() {
return 'no arguments';
}
Observable.fromEvent(obj, 'click', selector).take(1)
.subscribe(function (e) {
chai_1.expect(e).to.equal('no arguments');
}, function (err) {
done(new Error('should not be called'));
}, function () {
done();
});
send();
});
it('should pass multiple arguments to selector from event emitter', function (done) {
var send;
var obj = {
on: function (name, handler) {
send = handler;
},
off: function () {
//noop
}
};
function selector(x, y, z) {
return [].slice.call(arguments);
}
Observable.fromEvent(obj, 'click', selector).take(1)
.subscribe(function (e) {
chai_1.expect(e).to.deep.equal([1, 2, 3]);
}, function (err) {
done(new Error('should not be called'));
}, function () {
done();
});
send(1, 2, 3);
});
});
//# sourceMappingURL=fromEvent-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>