Skip to content
This repository has been archived by the owner on Aug 31, 2024. It is now read-only.

[#16] Remove spdy from docs #49

Merged
merged 1 commit into from
Sep 6, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ The Koala framework adds to Koa:
- Supports JSON, urlencoded, and multipart bodies
- Supports arbitrary strings, buffers, and files as bodies
- Optional nested parameter support
- [SPDY](docs/spdy.md) - specifically push streams
- [File Serving](docs/file-serving.md) - with SPDY push support
- [File Serving](docs/file-serving.md)
- [Sessions](docs/sessions.md)
- Cookie-based sessions
- CSRF protection
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ With Koa, it's easier as well as better to do atomic updates.

For example, if you use MongoDB, you might want to do something like: https://github.com/aheckmann/koa-mongodb-session/issues/5.

## Will other SPDY and HTTP/2 features be supported?
## Will other HTTP/2 features be supported?

A lot of these features belong at the `http.createServer()` state of
deploying your app, which Koala does not handle.
Expand Down
18 changes: 0 additions & 18 deletions docs/file-serving.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Don't try to juggle multiple static folders.

Some features of this static server:

- SPDY push support
- Creates strong `sha256` etags and caches them
- Caches `fs.stat()` calls
- Caches gzipped versions of these files
Expand All @@ -34,20 +33,3 @@ var app = koala({
}
})
```

## var file = yield* this.fileServer.push(path, [options])

SPDY push a file from the folder.
`path` must be relative without the leading `/`.
Errors will be thrown on unknown files.
The only `option` is `priority: 7`.

`yield*` is required here because it uses an `fs.stat()` call
to make sure the file exists.
`yield` again and it'll wait until the file has finished being pushed.

```js
app.use(function* (next) {
yield* this.fileServer.push('favicon.ico')
})
```
6 changes: 0 additions & 6 deletions docs/polyfills.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,3 @@ client's user-agent, giving them only what they need.

Add `<script src="/polyfill.js"></script>` to your page,
and the appropriate polyfills will be used on the page.

### [yield] this.polyfills.push()

To avoid that extra HTTP request delay,
SPDY push `polyfill.js` so your page loads as fast as possible.
You only need to do this when you serve HTML pages that have the script tag.
137 changes: 0 additions & 137 deletions docs/spdy.md

This file was deleted.