Skip to content

Commit 1fc8b20

Browse files
committed
add docs
1 parent 23c707d commit 1fc8b20

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,22 @@ app.get('/*', middleware);
8989
fastboot.reload();
9090
```
9191

92+
## Response chunking
93+
94+
By default, the middleware writes the complete response at once but response
95+
chunking (aka HTTP Streaming) is available via a config switch:
96+
97+
```js
98+
app.get('/*', fastbootMiddleware({
99+
distPath: '/path/to/dist',
100+
chunkedResponse: true
101+
}));
102+
```
103+
104+
Enabling response chunking will result in the response being delivered in
105+
multiple chunks (one for the head, one for the body and one for each shoebox)
106+
which helps getting the HTML to clients faster.
107+
92108
[ember-cli-fastboot]: https://github.com/ember-fastboot/ember-cli-fastboot
93109

94110
## Tests

0 commit comments

Comments
 (0)