Skip to content

Add references to Fetch, WebSocket, and Promise specs #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add references to Fetch, WebSocket, and Promise specs #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,13 @@ TODO

# Dependencies

TODO
FlyWeb uses [`Promise`][Promise reference] objects as defined in the [ES6
specification][Promise specification].

FlyWeb's API for hosting a server endpoint from a webpage uses the classes
defined in the [Fetch Standard] and the [WebSocket specification] to represent
both typical HTTP traffic [to][Fetch API request] and [from][Fetch API response]
the page-hosted server as well as [bidirectional, persistent connections][WebSocket interface].

# Terminology

Expand Down Expand Up @@ -170,11 +176,11 @@ interface FlyWebFetchEvent : Event {
};
```

The `request` attribute holds a DOM `Request` object describing the
details of the HTTP request.
The `request` attribute holds a DOM [`Request`][Fetch API request] object
describing the details of the HTTP request.

The `respondWith` method on the event can accept a `Promise` for
resolving a `Response` object to service the HTTP request.
resolving a [`Response`][Fetch API response] object to service the HTTP request.

### onwebsocket

Expand All @@ -193,12 +199,21 @@ interface FlyWebWebSocketEvent : Event {
};
```

The `request` attribute holds a DOM `Request` object describing the
The `request` attribute holds a DOM [`Request`][Fetch API Request] object describing the
details of the WebSocket request.

The `accept` method on the event can be used to accept the WebSocket
request. It immediately returns a WebSocket instance which can be used
request. It immediately returns a [`WebSocket`][WebSocket interface] instance which can be used
to communicate with the client.

The `respondWith` method on the event can accept a `Promise` for
resolving a `Response` object to service the WebSocket request.
resolving a [`Response`][Fetch API Response] object to service the WebSocket request.


[Fetch Standard]: https://fetch.spec.whatwg.org/
[Fetch API request]: https://fetch.spec.whatwg.org/#request-class
[Fetch API response]: https://fetch.spec.whatwg.org/#response-class
[WebSocket specification]: https://html.spec.whatwg.org/multipage/comms.html#network
[WebSocket interface]: https://html.spec.whatwg.org/multipage/comms.html#the-websocket-interface
[Promise specification]: http://www.ecma-international.org/ecma-262/6.0/#sec-promise-objects
[Promise reference]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise