-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathEventSource.html
More file actions
67 lines (59 loc) · 14.3 KB
/
Copy pathEventSource.html
File metadata and controls
67 lines (59 loc) · 14.3 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
63
64
65
66
67
<!DOCTYPE html><html><head><meta charset="utf-8"><title>EventSource JavaScript API</title><meta name="description" content="Interactive API reference for the JavaScript EventSource Object. EventSource allows listening to events pushed from the server. Similar to a WebSocket except it is a one way connection."><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>EventSource</h2><div class="navgroup"><div class="group"><a href="#Constructors">Constructors</a></div><div class="group collapsed"><a href="#InstanceProperties" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Properties</a><div class="subgroup"><a href="#readyState">readyState</a><a href="#url">url</a></div></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="#close_">close</a></div></div><div class="group collapsed"><a href="#InstanceEvents" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Events</a><div class="subgroup"><a href="#error">error</a><a href="#message">message</a><a href="#open">open</a></div></div><div class="group collapsed"><a href="#EventSourceProperties" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>EventSource Properties</a><div class="subgroup"><a href="#CLOSED">CLOSED</a><a href="#CONNECTING">CONNECTING</a><a href="#OPEN">OPEN</a></div></div></div><h2>ServerSentEvents 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">EventSource</span> <span class="type">: <a href="/EventTarget">EventTarget</a></span></h1><div class="metadata"><span>constructor</span></div><div class="objectdescription">EventSource allows listening to events pushed from the server. Similar to a <a href="/WebSocket">WebSocket</a> except it is a one way connection.<div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#the-eventsource-interface" class="spec">Spec</a></div></div><div><a name="Constructors"></a><h2>Constructors</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="EventSource"></a> <a name="new_EventSource_String_Object"></a><div class="declaration">new <span class="membername primary">EventSource</span>(<span class="membername">url</span> : <a class="membertype" href="/String">String</a>, <span class="optional">[<span class="membername">init</span> : <a class="membertype" href="/Object">Object</a>]</span>) : <a class="membertype" href="/EventSource">EventSource</a><div class="subfunction"><span class="membername">init</span> : {<table><tr><td><span class="membername">withCredentials</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr></table><span class="subfunctionclose">}</span></div></div><div class="member-body"><p class="description">Creates an EventSource.</p><div class="htmlexample"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="19" cols="60" wrap="off">
<form>
<label>message: <textarea name="message">my message</textarea></label><br>
<label>event: <input name="event" type="checkbox"></label><br>
<input type="submit">
</form>
<script>
const guid = [...crypto.getRandomValues(new Uint32Array(4))].map(x => x.toString(16).padStart(2, '0')).join('');
const echoUrl = `https://sse-echo.javascripture.com/?g=${guid}`;
const eventSource = new EventSource(echoUrl);
eventSource.onmessage = (event) => {
console.log('message data:', event.data);
}
eventSource.addEventListener('my-event', (event) => {
console.log('event data:', event.data);
});
// Send a message to the server that it echos back to eventSource
const form = document.querySelector('form');
form.onsubmit = async (e) => {
e.preventDefault();
let url = echoUrl;
if (form.event.checked) {
url += '&event=my-event';
}
await fetch(url , { method: 'POST', body: form.message.value });
};
</script>
</textarea><a onclick='executeHTMLExample(this.parentNode.parentNode, "EventSource.EventSource"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="htmlerrormessage" style="display: none"></div><iframe class="output" width="350" height="200"></iframe><pre class="results"> </pre></div></div></div><p></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource" class="spec">Spec</a></div></div></div></div><div><a name="InstanceProperties"></a><h2>Instance Properties</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="readyState"></a><div class="declaration"><span class="membername primary">readyState</span> : <a class="membertype" href="/Number">Number</a> <span class="metadata">readonly</span></div><div class="member-body"><p class="description">The current connection state. Will be one of <a href="#CONNECTING">CONNECTING</a>, <a href="#OPEN">OPEN</a>, or <a href="#CLOSED">CLOSED</a>.</p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
const guid = [...crypto.getRandomValues(new Uint32Array(4))].map(x => x.toString(16).padStart(2, '0')).join('');
const echoUrl = `https://sse-echo.javascripture.com/?g=${guid}`;
const names = new Map([
[EventSource.CONNECTING, 'CONNECTING'],
[EventSource.OPEN, 'OPEN'],
[EventSource.CLOSED, 'CLOSED']]);
const eventSource = new EventSource(echoUrl);
console.log('after construction. readyState:', names.get(eventSource.readyState));
eventSource.onopen = (event) => {
console.log('in onopen. readyState:', names.get(eventSource.readyState));
eventSource.close();
console.log('after close. readyState:', names.get(eventSource.readyState));
};
</textarea><a onclick='executeExample(this.parentNode.parentNode, "EventSource.readyState"); 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 class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource-readystate" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="url"></a><div class="declaration"><span class="membername primary">url</span> : <a class="membertype" href="/String">String</a> <span class="metadata">readonly</span></div><div class="member-body"><p class="description">The url <code>this</code> is connected to.</p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
const guid = [...crypto.getRandomValues(new Uint32Array(4))].map(x => x.toString(16).padStart(2, '0')).join('');
const echoUrl = `https://sse-echo.javascripture.com/?g=${guid}`;
const eventSource = new EventSource(echoUrl);
console.log(eventSource.url);
</textarea><a onclick='executeExample(this.parentNode.parentNode, "EventSource.url"); 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 class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource-withcredentials" class="spec">Spec</a></div></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="close"></a> <a name="close_"></a><div class="declaration"><span class="membername primary">close</span>() : <a class="membertype" href="/undefined">undefined</a></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource-close" class="spec">Spec</a></div></div></div></div><div><a name="InstanceEvents"></a><h2>Instance Events</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="error"></a> <a name="onerror"></a><div class="declaration"><span class="membername primary">onerror</span> / <span class="membername primary">'error'</span> <span class="metadata">event</span><div class="subfunction"><span class="membername">listener</span>(<span class="membername">event</span> : <a class="membertype" href="/ErrorEvent">ErrorEvent</a>) : <a class="membertype" href="/undefined">undefined</a></div></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#handler-eventsource-onerror" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="message"></a> <a name="onmessage"></a><div class="declaration"><span class="membername primary">onmessage</span> / <span class="membername primary">'message'</span> <span class="metadata">event</span><div class="subfunction"><span class="membername">listener</span>(<span class="membername">event</span> : <a class="membertype" href="/MessageEvent">MessageEvent</a>) : <a class="membertype" href="/undefined">undefined</a></div></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#handler-eventsource-onmessage" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="open"></a> <a name="onopen"></a><div class="declaration"><span class="membername primary">onopen</span> / <span class="membername primary">'open'</span> <span class="metadata">event</span><div class="subfunction"><span class="membername">listener</span>(<span class="membername">event</span> : <a class="membertype" href="/Event">Event</a>) : <a class="membertype" href="/undefined">undefined</a></div></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#handler-eventsource-onopen" class="spec">Spec</a></div></div></div></div><div><a name="EventSourceProperties"></a><h2>EventSource Properties</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="CLOSED"></a><div class="declaration"><span class="membername primary">CLOSED</span> : <a class="membertype" href="/Number">Number</a> <span class="metadata">value = 2</span></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource-closed" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="CONNECTING"></a><div class="declaration"><span class="membername primary">CONNECTING</span> : <a class="membertype" href="/Number">Number</a> <span class="metadata">value = 0</span></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource-connecting" class="spec">Spec</a></div></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="OPEN"></a><div class="declaration"><span class="membername primary">OPEN</span> : <a class="membertype" href="/Number">Number</a> <span class="metadata">value = 1</span></div><div class="member-body"><p class="description"></p><div class="membermetadata"><a href="https://html.spec.whatwg.org/multipage/server-sent-events.html#dom-eventsource-open" class="spec">Spec</a></div></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>