UNPKG

@reactivex/rxjs

Version:

Reactive Extensions for modern JavaScript

335 lines (325 loc) 18.3 kB
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../"> <title data-ice="title">spec-js/Notification-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/Notification-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 Notification = Rx.Notification; /** @test {Notification} */ describe(&apos;Notification&apos;, function () { it(&apos;should exist&apos;, function () { chai_1.expect(Notification).exist; chai_1.expect(Notification).to.be.a(&apos;function&apos;); }); it(&apos;should not allow convert to observable if given kind is unknown&apos;, function () { var n = new Notification(&apos;x&apos;); chai_1.expect(function () { return n.toObservable(); }).to.throw(); }); describe(&apos;createNext&apos;, function () { it(&apos;should return a Notification&apos;, function () { var n = Notification.createNext(&apos;test&apos;); chai_1.expect(n instanceof Notification).to.be.true; chai_1.expect(n.value).to.equal(&apos;test&apos;); chai_1.expect(n.kind).to.equal(&apos;N&apos;); chai_1.expect(n.error).to.be.a(&apos;undefined&apos;); chai_1.expect(n.hasValue).to.be.true; }); }); describe(&apos;createError&apos;, function () { it(&apos;should return a Notification&apos;, function () { var n = Notification.createError(&apos;test&apos;); chai_1.expect(n instanceof Notification).to.be.true; chai_1.expect(n.value).to.be.a(&apos;undefined&apos;); chai_1.expect(n.kind).to.equal(&apos;E&apos;); chai_1.expect(n.error).to.equal(&apos;test&apos;); chai_1.expect(n.hasValue).to.be.false; }); }); describe(&apos;createComplete&apos;, function () { it(&apos;should return a Notification&apos;, function () { var n = Notification.createComplete(); chai_1.expect(n instanceof Notification).to.be.true; chai_1.expect(n.value).to.be.a(&apos;undefined&apos;); chai_1.expect(n.kind).to.equal(&apos;C&apos;); chai_1.expect(n.error).to.be.a(&apos;undefined&apos;); chai_1.expect(n.hasValue).to.be.false; }); }); describe(&apos;toObservable&apos;, function () { it(&apos;should create observable from a next Notification&apos;, function () { var value = &apos;a&apos;; var next = Notification.createNext(value); expectObservable(next.toObservable()).toBe(&apos;(a|)&apos;); }); it(&apos;should create observable from a complete Notification&apos;, function () { var complete = Notification.createComplete(); expectObservable(complete.toObservable()).toBe(&apos;|&apos;); }); it(&apos;should create observable from a error Notification&apos;, function () { var error = Notification.createError(&apos;error&apos;); expectObservable(error.toObservable()).toBe(&apos;#&apos;); }); }); describe(&apos;static reference&apos;, function () { it(&apos;should create new next Notification with value&apos;, function () { var value = &apos;a&apos;; var first = Notification.createNext(value); var second = Notification.createNext(value); chai_1.expect(first).not.to.equal(second); }); it(&apos;should create new error Notification&apos;, function () { var first = Notification.createError(); var second = Notification.createError(); chai_1.expect(first).not.to.equal(second); }); it(&apos;should return static next Notification reference without value&apos;, function () { var first = Notification.createNext(undefined); var second = Notification.createNext(undefined); chai_1.expect(first).to.equal(second); }); it(&apos;should return static complete Notification reference&apos;, function () { var first = Notification.createComplete(); var second = Notification.createComplete(); chai_1.expect(first).to.equal(second); }); }); describe(&apos;do&apos;, function () { it(&apos;should invoke on next&apos;, function () { var n = Notification.createNext(&apos;a&apos;); var invoked = false; n.do(function (x) { invoked = true; }, function (err) { throw &apos;should not be called&apos;; }, function () { throw &apos;should not be called&apos;; }); chai_1.expect(invoked).to.be.true; }); it(&apos;should invoke on error&apos;, function () { var n = Notification.createError(); var invoked = false; n.do(function (x) { throw &apos;should not be called&apos;; }, function (err) { invoked = true; }, function () { throw &apos;should not be called&apos;; }); chai_1.expect(invoked).to.be.true; }); it(&apos;should invoke on complete&apos;, function () { var n = Notification.createComplete(); var invoked = false; n.do(function (x) { throw &apos;should not be called&apos;; }, function (err) { throw &apos;should not be called&apos;; }, function () { invoked = true; }); chai_1.expect(invoked).to.be.true; }); }); describe(&apos;accept&apos;, function () { it(&apos;should accept observer for next Notification&apos;, function () { var value = &apos;a&apos;; var observed = false; var n = Notification.createNext(value); var observer = Rx.Subscriber.create(function (x) { chai_1.expect(x).to.equal(value); observed = true; }, function (err) { throw &apos;should not be called&apos;; }, function () { throw &apos;should not be called&apos;; }); n.accept(observer); chai_1.expect(observed).to.be.true; }); it(&apos;should accept observer for error Notification&apos;, function () { var observed = false; var n = Notification.createError(); var observer = Rx.Subscriber.create(function (x) { throw &apos;should not be called&apos;; }, function (err) { observed = true; }, function () { throw &apos;should not be called&apos;; }); n.accept(observer); chai_1.expect(observed).to.be.true; }); it(&apos;should accept observer for complete Notification&apos;, function () { var observed = false; var n = Notification.createComplete(); var observer = Rx.Subscriber.create(function (x) { throw &apos;should not be called&apos;; }, function (err) { throw &apos;should not be called&apos;; }, function () { observed = true; }); n.accept(observer); chai_1.expect(observed).to.be.true; }); it(&apos;should accept function for next Notification&apos;, function () { var value = &apos;a&apos;; var observed = false; var n = Notification.createNext(value); n.accept(function (x) { chai_1.expect(x).to.equal(value); observed = true; }, function (err) { throw &apos;should not be called&apos;; }, function () { throw &apos;should not be called&apos;; }); chai_1.expect(observed).to.be.true; }); it(&apos;should accept function for error Notification&apos;, function () { var observed = false; var error = &apos;error&apos;; var n = Notification.createError(error); n.accept(function (x) { throw &apos;should not be called&apos;; }, function (err) { chai_1.expect(err).to.equal(error); observed = true; }, function () { throw &apos;should not be called&apos;; }); chai_1.expect(observed).to.be.true; }); it(&apos;should accept function for complete Notification&apos;, function () { var observed = false; var n = Notification.createComplete(); n.accept(function (x) { throw &apos;should not be called&apos;; }, function (err) { throw &apos;should not be called&apos;; }, function () { observed = true; }); chai_1.expect(observed).to.be.true; }); }); describe(&apos;observe&apos;, function () { it(&apos;should observe for next Notification&apos;, function () { var value = &apos;a&apos;; var observed = false; var n = Notification.createNext(value); var observer = Rx.Subscriber.create(function (x) { chai_1.expect(x).to.equal(value); observed = true; }, function (err) { throw &apos;should not be called&apos;; }, function () { throw &apos;should not be called&apos;; }); n.observe(observer); chai_1.expect(observed).to.be.true; }); it(&apos;should observe for error Notification&apos;, function () { var observed = false; var n = Notification.createError(); var observer = Rx.Subscriber.create(function (x) { throw &apos;should not be called&apos;; }, function (err) { observed = true; }, function () { throw &apos;should not be called&apos;; }); n.observe(observer); chai_1.expect(observed).to.be.true; }); it(&apos;should observe for complete Notification&apos;, function () { var observed = false; var n = Notification.createComplete(); var observer = Rx.Subscriber.create(function (x) { throw &apos;should not be called&apos;; }, function (err) { throw &apos;should not be called&apos;; }, function () { observed = true; }); n.observe(observer); chai_1.expect(observed).to.be.true; }); }); }); //# sourceMappingURL=Notification-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>