Skip to content

docs: remove public #3350

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

Merged
merged 2 commits into from
May 26, 2021
Merged

docs: remove public #3350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5761c23
docs: remove public
anshumanv May 26, 2021
afd7c60
docs: update
anshumanv May 26, 2021
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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,6 @@ Options:
--no-history-api-fallback Do not fallback to /index.html for Single Page Applications.
--compress Enable gzip compression.
--no-compress Disable gzip compression.
--public <value> The public hostname/ip address of the server.
--firewall [value...] Enable firewall or set hosts that are allowed to access the dev server.
--no-firewall Disable firewall.
--watch-files <value...> Watch static files for file changes.
Expand Down
4 changes: 2 additions & 2 deletions examples/cli/web-socket-url/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# CLI: Public Option Protocol
# CLI: Web Socket URL Option Protocol

```console
npx webpack serve
```

_NOTE: replace `<insert local ip>` with your local IP Address._

You're now able to explicitly define the protocol used with the `public` option
You're now able to explicitly define the protocol used with the `client.webSocketURL` option
(have a look to the config provided in `webpack.config.js`).

## What Should Happen
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/web-socket-server-and-url.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,7 +404,7 @@ for (const webSocketServerType of webSocketServerTypes) {
afterAll(testServer.close);

describe('browser client', () => {
it('uses the correct public hostname and path', (done) => {
it('uses the correct webSocketURL hostname and path', (done) => {
runBrowser().then(({ page, browser }) => {
waitForTest(browser, page, /foo\/test\/bar/, (websocketUrl) => {
expect(websocketUrl).toContain(
Expand Down