docs(hmr): document hmr.server option (fix #3587) (#3590)

* docs(hmr): document hmr.server option

* docs(hmr): hmr.server apply suggestions
This commit is contained in:
Joe Busillo 2021-05-29 22:47:03 -05:00 committed by GitHub
parent 82ec0ca69c
commit a30724c8a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 2 deletions

View File

@ -427,7 +427,7 @@ export default async ({ command, mode }) => {
### server.hmr
- **Type:** `boolean | { protocol?: string, host?: string, port?: number, path?: string, timeout?: number, overlay?: boolean, clientPort?: number }`
- **Type:** `boolean | { protocol?: string, host?: string, port?: number, path?: string, timeout?: number, overlay?: boolean, clientPort?: number, server?: Server }`
Disable or configure HMR connection (in cases where the HMR websocket must use a different address from the http server).
@ -435,6 +435,9 @@ export default async ({ command, mode }) => {
`clientPort` is an advanced option that overrides the port only on the client side, allowing you to serve the websocket on a different port than the client code looks for it on. Useful if you're using an SSL proxy in front of your dev server.
When using `server.middlewareMode` and `server.https`, setting `server.hmr.server` to your HTTPS server will process HMR secure connection requests through your server. This can be helpful when using self-signed certificates.
### server.watch
- **Type:** `object`

View File

@ -2953,7 +2953,7 @@ Repository: git@github.com:teambition/merge2.git
## micromatch
License: MIT
By: Jon Schlinkert, Amila Welihinda, Bogdan Chadkin, Brian Woodward, Devon Govett, Elan Shanker, Fabrício Matté, Martin Kolárik, Olsten Larck, Paul Miller, Tom Byrer, Tyler Akins, Peter Bright
By: Jon Schlinkert, Amila Welihinda, Bogdan Chadkin, Brian Woodward, Devon Govett, Elan Shanker, Fabrício Matté, Martin Kolárik, Olsten Larck, Paul Miller, Tom Byrer, Tyler Akins, Peter Bright, Kuba Juszczyk
Repository: micromatch/micromatch
> The MIT License (MIT)