@reactivex/rxjs
Version:
Reactive Extensions for modern JavaScript
1,749 lines (948 loc) • 49.6 kB
HTML
<html>
<head>
<meta charset="utf-8">
<base data-ice="baseUrl" href="../">
<title data-ice="title">Variable | 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">Variable</h1>
<div data-ice="summaries"><table class="summary" data-ice="summary">
<thead><tr><td data-ice="title" colspan="3">Static Public Summary</td></tr></thead>
<tbody>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Action">Action</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>A unit of work to be executed in a <span><a href="variable/index.html#static-variable-Scheduler">Scheduler</a></span>.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-AjaxError">AjaxError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>A normalized AJAX error.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-AjaxResponse">AjaxResponse</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>A normalized AJAX response.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-AjaxTimeoutError">AjaxTimeoutError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-AnonymousSubject">AnonymousSubject</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-ArgumentOutOfRangeError">ArgumentOutOfRangeError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An error thrown when an element was queried at a certain index of an
Observable, but no such index or position exists in that sequence.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-AsyncSubject">AsyncSubject</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-BehaviorSubject">BehaviorSubject</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-ConnectableObservable">ConnectableObservable</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-EmptyError">EmptyError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An error thrown when an Observable or a sequence was queried but has no
elements.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-GroupedObservable">GroupedObservable</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An Observable representing values belonging to the same group represented by
a common key.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Notification">Notification</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Represents a push-based event or value that an <span><a href="variable/index.html#static-variable-Observable">Observable</a></span> can emit.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-ObjectUnsubscribedError">ObjectUnsubscribedError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An error thrown when an action is invalid because the object has been
unsubscribed.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Observable">Observable</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>A representation of any set of values over any amount of time.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-ReplaySubject">ReplaySubject</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Scheduler">Scheduler</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An execution context and a data structure to order tasks and schedule their
execution.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Subject">Subject</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-SubjectSubscriber">SubjectSubscriber</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Subscriber">Subscriber</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Implements the <span>Observer</span> interface and extends the
<span><a href="variable/index.html#static-variable-Subscription">Subscription</a></span> class.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-Subscription">Subscription</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>Represents a disposable resource, such as the execution of an Observable.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-TimeoutError">TimeoutError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An error thrown when duetime elapses.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-UnsubscriptionError">UnsubscriptionError</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>An error thrown when one or more errors have occurred during the
<code>unsubscribe</code> of a <span><a href="variable/index.html#static-variable-Subscription">Subscription</a></span>.</p>
</div>
</div>
</td>
<td>
</td>
</tr>
<tr data-ice="target">
<td>
<span class="access" data-ice="access">public</span>
<span class="override" data-ice="override"></span>
</td>
<td>
<div>
<p>
<span data-ice="name"><span><a href="variable/index.html#static-variable-root">root</a></span></span><span data-ice="signature">: <span>*</span></span>
</p>
</div>
<div>
<div data-ice="description"><p>window: browser in DOM main thread
self: browser in WebWorker
global: Node.js/other</p>
</div>
</div>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<div data-ice="details"><h2 data-ice="title">Static Public </h2>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Action">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Action</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/scheduler/Action.js.html#lineNumber16">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Action} from '<span><a href="file/es6/scheduler/Action.js.html#lineNumber16">@reactivex/rxjs/es6/scheduler/Action.js</a></span>'</code></pre></div>
<div data-ice="description"><p>A unit of work to be executed in a <span><a href="variable/index.html#static-variable-Scheduler">Scheduler</a></span>. An action is typically
created from within a Scheduler and an RxJS user does not need to concern
themselves about creating and manipulating an Action.</p>
<pre><code class="lang-ts"><code class="source-code prettyprint">class Action<T> extends Subscription {
new (scheduler: Scheduler, work: (state?: T) => void);
schedule(state?: T, delay: number = 0): Subscription;
}</code>
</code></pre>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-AjaxError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">AjaxError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/observable/dom/AjaxObservable.js.html#lineNumber362">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AjaxError} from '<span><a href="file/es6/observable/dom/AjaxObservable.js.html#lineNumber362">@reactivex/rxjs/es6/observable/dom/AjaxObservable.js</a></span>'</code></pre></div>
<div data-ice="description"><p>A normalized AJAX error.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span>ajax</span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-AjaxResponse">
<span class="access" data-ice="access">public</span>
<span data-ice="name">AjaxResponse</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/observable/dom/AjaxObservable.js.html#lineNumber327">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AjaxResponse} from '<span><a href="file/es6/observable/dom/AjaxObservable.js.html#lineNumber327">@reactivex/rxjs/es6/observable/dom/AjaxObservable.js</a></span>'</code></pre></div>
<div data-ice="description"><p>A normalized AJAX response.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span>ajax</span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-AjaxTimeoutError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">AjaxTimeoutError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/observable/dom/AjaxObservable.js.html#lineNumber378">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AjaxTimeoutError} from '<span><a href="file/es6/observable/dom/AjaxObservable.js.html#lineNumber378">@reactivex/rxjs/es6/observable/dom/AjaxObservable.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span>ajax</span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-AnonymousSubject">
<span class="access" data-ice="access">public</span>
<span data-ice="name">AnonymousSubject</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Subject.js.html#lineNumber115">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AnonymousSubject} from '<span><a href="file/es6/Subject.js.html#lineNumber115">@reactivex/rxjs/es6/Subject.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-ArgumentOutOfRangeError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">ArgumentOutOfRangeError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/util/ArgumentOutOfRangeError.js.html#lineNumber11">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {ArgumentOutOfRangeError} from '<span><a href="file/es6/util/ArgumentOutOfRangeError.js.html#lineNumber11">@reactivex/rxjs/es6/util/ArgumentOutOfRangeError.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An error thrown when an element was queried at a certain index of an
Observable, but no such index or position exists in that sequence.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span><a href="variable/index.html#instance-method-elementAt">elementAt</a></span></span></li>
<li><span><span><a href="variable/index.html#instance-method-take">take</a></span></span></li>
<li><span><span><a href="variable/index.html#instance-method-takeLast">takeLast</a></span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-AsyncSubject">
<span class="access" data-ice="access">public</span>
<span data-ice="name">AsyncSubject</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/AsyncSubject.js.html#lineNumber6">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {AsyncSubject} from '<span><a href="file/es6/AsyncSubject.js.html#lineNumber6">@reactivex/rxjs/es6/AsyncSubject.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/subjects/AsyncSubject-spec.js.html#lineNumber21">AsyncSubject</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-BehaviorSubject">
<span class="access" data-ice="access">public</span>
<span data-ice="name">BehaviorSubject</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/BehaviorSubject.js.html#lineNumber6">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {BehaviorSubject} from '<span><a href="file/es6/BehaviorSubject.js.html#lineNumber6">@reactivex/rxjs/es6/BehaviorSubject.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/subjects/BehaviorSubject-spec.js.html#lineNumber8">BehaviorSubject</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-ConnectableObservable">
<span class="access" data-ice="access">public</span>
<span data-ice="name">ConnectableObservable</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/observable/ConnectableObservable.js.html#lineNumber8">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {ConnectableObservable} from '<span><a href="file/es6/observable/ConnectableObservable.js.html#lineNumber8">@reactivex/rxjs/es6/observable/ConnectableObservable.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-EmptyError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">EmptyError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/util/EmptyError.js.html#lineNumber11">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {EmptyError} from '<span><a href="file/es6/util/EmptyError.js.html#lineNumber11">@reactivex/rxjs/es6/util/EmptyError.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An error thrown when an Observable or a sequence was queried but has no
elements.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span>first</span></span></li>
<li><span><span>last</span></span></li>
<li><span><span><a href="variable/index.html#instance-method-single">single</a></span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-GroupedObservable">
<span class="access" data-ice="access">public</span>
<span data-ice="name">GroupedObservable</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/operator/groupBy.js.html#lineNumber163">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {GroupedObservable} from '<span><a href="file/es6/operator/groupBy.js.html#lineNumber163">@reactivex/rxjs/es6/operator/groupBy.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An Observable representing values belonging to the same group represented by
a common key. The values emitted by a GroupedObservable come from the source
Observable. The common key is available as the field <code>key</code> on a
GroupedObservable instance.</p>
</div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Notification">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Notification</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Notification.js.html#lineNumber16">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Notification} from '<span><a href="file/es6/Notification.js.html#lineNumber16">@reactivex/rxjs/es6/Notification.js</a></span>'</code></pre></div>
<div data-ice="description"><p>Represents a push-based event or value that an <span><a href="variable/index.html#static-variable-Observable">Observable</a></span> can emit.
This class is particularly useful for operators that manage notifications,
like <span><a href="variable/index.html#instance-method-materialize">materialize</a></span>, <span><a href="variable/index.html#instance-method-dematerialize">dematerialize</a></span>, <span><a href="variable/index.html#instance-method-observeOn">observeOn</a></span>, and
others. Besides wrapping the actual delivered value, it also annotates it
with metadata of, for instance, what type of push message it is (<code>next</code>,
<code>error</code>, or <code>complete</code>).</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/Notification-spec.js.html#lineNumber6">Notification</a></span></li>
</ul>
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span><a href="variable/index.html#instance-method-materialize">materialize</a></span></span></li>
<li><span><span><a href="variable/index.html#instance-method-dematerialize">dematerialize</a></span></span></li>
<li><span><span><a href="variable/index.html#instance-method-observeOn">observeOn</a></span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-ObjectUnsubscribedError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">ObjectUnsubscribedError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/util/ObjectUnsubscribedError.js.html#lineNumber10">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {ObjectUnsubscribedError} from '<span><a href="file/es6/util/ObjectUnsubscribedError.js.html#lineNumber10">@reactivex/rxjs/es6/util/ObjectUnsubscribedError.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An error thrown when an action is invalid because the object has been
unsubscribed.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span><a href="variable/index.html#static-variable-Subject">Subject</a></span></span></li>
<li><span><span><a href="variable/index.html#static-variable-BehaviorSubject">BehaviorSubject</a></span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Observable">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Observable</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Observable.js.html#lineNumber10">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Observable} from '<span><a href="file/es6/Observable.js.html#lineNumber10">@reactivex/rxjs/es6/Observable.js</a></span>'</code></pre></div>
<div data-ice="description"><p>A representation of any set of values over any amount of time. This the most basic building block
of RxJS.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/Observable-spec.js.html#lineNumber19">Observable</a></span></li>
<li data-ice="test"><span><a href="test-file/spec-js/Observable-spec.js.html#lineNumber470">Observable.create</a></span></li>
<li data-ice="test"><span><a href="test-file/spec-js/Observable-spec.js.html#lineNumber497">Observable.lift</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-ReplaySubject">
<span class="access" data-ice="access">public</span>
<span data-ice="name">ReplaySubject</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/ReplaySubject.js.html#lineNumber10">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {ReplaySubject} from '<span><a href="file/es6/ReplaySubject.js.html#lineNumber10">@reactivex/rxjs/es6/ReplaySubject.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/subjects/ReplaySubject-spec.js.html#lineNumber7">ReplaySubject</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Scheduler">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Scheduler</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Scheduler.js.html#lineNumber17">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Scheduler} from '<span><a href="file/es6/Scheduler.js.html#lineNumber17">@reactivex/rxjs/es6/Scheduler.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An execution context and a data structure to order tasks and schedule their
execution. Provides a notion of (potentially virtual) time, through the
<code>now()</code> getter method.</p>
<p>Each unit of work in a Scheduler is called an <span><a href="variable/index.html#static-variable-Action">Action</a></span>.</p>
<pre><code class="lang-ts"><code class="source-code prettyprint">class Scheduler {
now(): number;
schedule(work, delay?, state?): Subscription;
}</code>
</code></pre>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/schedulers/AnimationFrameScheduler-spec.js.html#lineNumber7">Scheduler.animationFrame</a></span></li>
<li data-ice="test"><span><a href="test-file/spec-js/schedulers/AsapScheduler-spec.js.html#lineNumber7">Scheduler.asap</a></span></li>
<li data-ice="test"><span><a href="test-file/spec-js/schedulers/QueueScheduler-spec.js.html#lineNumber8">Scheduler.queue</a></span></li>
<li data-ice="test"><span><a href="test-file/spec-js/Scheduler-spec.js.html#lineNumber6">Scheduler.queue</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Subject">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Subject</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Subject.js.html#lineNumber21">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Subject} from '<span><a href="file/es6/Subject.js.html#lineNumber21">@reactivex/rxjs/es6/Subject.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/Subject-spec.js.html#lineNumber8">Subject</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-SubjectSubscriber">
<span class="access" data-ice="access">public</span>
<span data-ice="name">SubjectSubscriber</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Subject.js.html#lineNumber10">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {SubjectSubscriber} from '<span><a href="file/es6/Subject.js.html#lineNumber10">@reactivex/rxjs/es6/Subject.js</a></span>'</code></pre></div>
<div data-ice="properties">
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Subscriber">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Subscriber</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Subscriber.js.html#lineNumber15">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Subscriber} from '<span><a href="file/es6/Subscriber.js.html#lineNumber15">@reactivex/rxjs/es6/Subscriber.js</a></span>'</code></pre></div>
<div data-ice="description"><p>Implements the <span>Observer</span> interface and extends the
<span><a href="variable/index.html#static-variable-Subscription">Subscription</a></span> class. While the <span>Observer</span> is the public API for
consuming the values of an <span><a href="variable/index.html#static-variable-Observable">Observable</a></span>, all Observers get converted to
a Subscriber, in order to provide Subscription-like capabilities such as
<code>unsubscribe</code>. Subscriber is a common type in RxJS, and crucial for
implementing operators, but it is rarely used as a public API.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/Subscriber-spec.js.html#lineNumber7">Subscriber</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-Subscription">
<span class="access" data-ice="access">public</span>
<span data-ice="name">Subscription</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/Subscription.js.html#lineNumber19">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {Subscription} from '<span><a href="file/es6/Subscription.js.html#lineNumber19">@reactivex/rxjs/es6/Subscription.js</a></span>'</code></pre></div>
<div data-ice="description"><p>Represents a disposable resource, such as the execution of an Observable. A
Subscription has one important method, <code>unsubscribe</code>, that takes no argument
and just disposes the resource held by the subscription.</p>
<p>Additionally, subscriptions may be grouped together through the <code>add()</code>
method, which will attach a child Subscription to the current Subscription.
When a Subscription is unsubscribed, all its children (and its grandchildren)
will be unsubscribed as well.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/Subscription-spec.js.html#lineNumber7">Subscription</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-TimeoutError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">TimeoutError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/util/TimeoutError.js.html#lineNumber8">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {TimeoutError} from '<span><a href="file/es6/util/TimeoutError.js.html#lineNumber8">@reactivex/rxjs/es6/util/TimeoutError.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An error thrown when duetime elapses.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="see"><h4>See:</h4><ul><li><span><span><a href="variable/index.html#instance-method-timeout">timeout</a></span></span></li></ul></div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-UnsubscriptionError">
<span class="access" data-ice="access">public</span>
<span data-ice="name">UnsubscriptionError</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/util/UnsubscriptionError.js.html#lineNumber5">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {UnsubscriptionError} from '<span><a href="file/es6/util/UnsubscriptionError.js.html#lineNumber5">@reactivex/rxjs/es6/util/UnsubscriptionError.js</a></span>'</code></pre></div>
<div data-ice="description"><p>An error thrown when one or more errors have occurred during the
<code>unsubscribe</code> of a <span><a href="variable/index.html#static-variable-Subscription">Subscription</a></span>.</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/util/UnsubscriptionError-spec.js.html#lineNumber6">UnsubscriptionError</a></span></li>
</ul>
</div>
</div>
<div class="detail" data-ice="detail">
<h3 data-ice="anchor" id="static-variable-root">
<span class="access" data-ice="access">public</span>
<span data-ice="name">root</span><span data-ice="signature">: <span>*</span></span>
<span class="right-info">
<span data-ice="source"><span><a href="file/es6/util/root.js.html#lineNumber6">source</a></span></span>
</span>
</h3>
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import {root} from '<span><a href="file/es6/util/root.js.html#lineNumber6">@reactivex/rxjs/es6/util/root.js</a></span>'</code></pre></div>
<div data-ice="description"><p>window: browser in DOM main thread
self: browser in WebWorker
global: Node.js/other</p>
</div>
<div data-ice="properties">
</div>
<div data-ice="tests">
<h4>Test:</h4>
<ul>
<li data-ice="test"><span><a href="test-file/spec-js/util/root-spec.js.html#lineNumber5">root</a></span></li>
</ul>
</div>
</div>
</div>
</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>