Skip to content
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.

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

chore: Add note to readme about HMR with HTTP2 #184

Merged
merged 1 commit into from
Sep 6, 2020
Merged
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ If `true`, will enable [`Hot Module Replacement`](https://webpack.js.org/concept

_Note: If the build process generates errors, the client (browser) will not be notified of new changes and no HMR will be performed. Errors must be resolved before HMR can proceed._

_Note: If using in combination with `http2`, the `http2` option `allowHTTP1` must be enabled for the HMR WS connection to work._

### `host`
Type: `String | Promise`<br>
Default: `::` for IPv6, `127.0.0.1` for IPv4
Expand All @@ -151,6 +153,8 @@ Type: `boolean` | [`http2` options](https://nodejs.org/api/http2.html#http2_http

If set, this option will instruct the server to enable HTTP2. Properties for this option should correspond to [HTTP2 options][http2] or [HTTP2 SSL options][http2tls].

_Note: If using in combination with `hmr`, the option `allowHTTP1` must be enabled for the HMR WS connection to work._

### `https`
Type: `Object`<br>
Default: `null`
Expand Down