-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathAsyncIterator.html
More file actions
62 lines (52 loc) · 7.43 KB
/
Copy pathAsyncIterator.html
File metadata and controls
62 lines (52 loc) · 7.43 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!DOCTYPE html><html><head><meta charset="utf-8"><title>AsyncIterator JavaScript API</title><meta name="description" content="Interactive API reference for the JavaScript AsyncIterator Object.
An AsyncIterator is an Object that returns a sequence of Promises.
Since AsyncIterators are AsyncIterables, you can use for await"><link rel="stylesheet" type="text/css" href="styles.css"><script type="text/javascript">var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23450559-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();</script></head><body><script>if (sessionStorage.collapsed === 'true') {
document.body.classList.add('members-collapsed');
}
if (localStorage.theme) {
document.body.parentElement.classList.add(localStorage.theme);
}</script><div class="topnav"><a href="/">JavaScripture</a><div class="bookmarks"><a class="bookmark contribute" href="https://github.com/nkronlage/JavaScripture">Contribute via GitHub</a> <a class="bookmark" href="/feedback">Feedback</a></div></div><div class="container"><nav class="leftnav"><div id="searchContainer"><input id="searchBox" type="text" placeholder="Search (Ctrl + S)" autocomplete="false"><div id="resultsBox" style="display:none;"></div></div><div id="apichooser"><a href="#" onclick="openApiChooser(); return false;"><div class="arrow"></div><span id="selectedsets"></span></a><div id="obscure"></div><div id="apisets"><ul></ul></div></div><div class="toc"><h2>AsyncIterator</h2><div class="navgroup"><div class="group"><a href="#InstanceIndexers">Instance Indexers</a></div><div class="group collapsed"><a href="#InstanceMethods" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Methods</a><div class="subgroup"><a href="#next_Object">next</a><a href="#return_Object">return</a><a href="#throw_Object">throw</a></div></div></div><h2>JavaScript API</h2><div id="related-apis" class="navgroup"></div><h2>All API</h2><div id="rootObjs" class="navgroup"><span class="empty">No API set selected.</span></div></div></nav><div class="content"><h1 class="declaration"><span class="object">AsyncIterator</span> <span class="type">: <a href="/AsyncIterable">AsyncIterable</a></span></h1><div class="metadata"></div><div class="objectdescription"><p>An AsyncIterator is an Object that returns a sequence of Promises.</p><p>Since AsyncIterators are AsyncIterables, you can use <code>for await (const value of iterable) {}</code> to easily loop over the values in an AsyncIterator.</p><p>Calling an async generator function (<code>async function* () {}</code>) returns an AsyncIterator.</p><p>See <a href="/AsyncIterable">AsyncIterable</a> for more details.</p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
const sleep = t => new Promise(r => setTimeout(r, t));
const stream = async function*() {
for (let i = 0; i < 3; i++) {
await sleep(300 * i);
yield i;
}
};
const iterator = stream();
console.dir(await iterator.next());
console.dir(await iterator.next());
console.dir(await iterator.next());
console.dir(await iterator.next());
// for-await-of loops make it easy to loop over async iterables
for await (const i of stream()) {
console.log(i);
}
</textarea><a onclick='executeExample(this.parentNode.parentNode, "AsyncIterator.AsyncIterator"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="errormessage" style="display: none"></div><pre class="results"> </pre></div></div></div><div class="membermetadata"><a href="http://www.ecma-international.org/ecma-262/10.0/#sec-asynciterator-interface" class="spec">Spec</a></div></div><div><a name="InstanceIndexers"></a><h2>Instance Indexers</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="indexer_Symbol_asyncIterator"></a><div class="declaration"><span class="membername primary">this</span>[<a href="/Symbol#asyncIterator"><span class="membername">Symbol.asyncIterator</span></a>] : <a class="membertype" href="/Function">Function</a><<a class="membertype" href="/AsyncIterator">AsyncIterator</a>></div><div class="member-body"><p class="description">Returns a method that returns <code>this</code>.</p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
const sleep = t => new Promise(r => setTimeout(r, t));
const stream = async function*() {
for (let i = 0; i < 3; i++) {
await sleep(300 * i);
yield i;
}
};
const iterator = stream();
var iteratorIterator = iterator[Symbol.asyncIterator]();
console.log(iterator === iteratorIterator);
console.log();
for await (const x of stream()) {
console.log(x);
}
console.log();
// Since AsyncIterators are also AsyncIterables, you can use for-await-of loops with them.
for await (const x of iterator) {
console.log(x);
}
</textarea><a onclick='executeExample(this.parentNode.parentNode, "AsyncIterator.undefined"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="errormessage" style="display: none"></div><pre class="results"> </pre></div></div></div><p></p></div></div></div><div><a name="InstanceMethods"></a><h2>Instance Methods</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="next"></a> <a name="next_Object"></a><div class="declaration"><span class="membername primary">next</span>(<span class="optional">[<span class="membername">yieldValue</span> : <a class="membertype" href="/Object">Object</a>]</span>) : <a class="membertype" href="/Promise">Promise</a></div><div class="member-body"><p class="description">Promise return type: { value : Object, done : Boolean }</p></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="return"></a> <a name="return_Object"></a><div class="declaration"><span class="membername primary">return</span>(<span class="optional">[<span class="membername">yieldValue</span> : <a class="membertype" href="/Object">Object</a>]</span>) : <a class="membertype" href="/Promise">Promise</a></div><div class="member-body"><p class="description"></p></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="throw"></a> <a name="throw_Object"></a><div class="declaration"><span class="membername primary">throw</span>(<span class="optional">[<span class="membername">rejectReason</span> : <a class="membertype" href="/Object">Object</a>]</span>) : <a class="membertype" href="/Promise">Promise</a></div><div class="member-body"><p class="description"></p></div></div></div><div class="bottomnav"><a href="/">home</a> <a href="/license">license</a> <a href="https://github.com/nkronlage/JavaScripture">contribute</a> <a href="/feedback">feedback</a> <a id="toggle-theme" href="#">toggle light/dark mode</a></div><div class="copyright">Copyright © JavaScripture Contributors</div></div></div></body><script src="javascripture.js"></script></html>