-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add
stopCallback
method example (#3876)
- Loading branch information
Showing
4 changed files
with
81 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# API: stopCallback(callback) | ||
|
||
While it's recommended to run `webpack-dev-server` via the CLI, you may also choose to start a server via the API. | ||
|
||
This example demonstrates using `stopCallback(callback)` method. It instructs `webpack-dev-server` instance to stop the server and then run the callback function. | ||
|
||
```js | ||
const Webpack = require("webpack"); | ||
const WebpackDevServer = require("webpack-dev-server"); | ||
const webpackConfig = require("./webpack.config"); | ||
|
||
const compiler = Webpack(webpackConfig); | ||
const devServerOptions = { ...webpackConfig.devServer }; | ||
const server = new WebpackDevServer(devServerOptions, compiler); | ||
|
||
server.startCallback(() => { | ||
console.log("Successfully started server on http://localhost:8080"); | ||
}); | ||
|
||
const stopServer = () => | ||
server.stopCallback(() => { | ||
console.log("Server stopped."); | ||
}); | ||
|
||
setTimeout(stopServer, 5000); | ||
``` | ||
|
||
Use the following command to run this example: | ||
|
||
```console | ||
node server.js | ||
``` | ||
|
||
## What Should Happen | ||
|
||
1. The script should start the server and open `http://localhost:8080/` in your default browser. | ||
2. You should see the text on the page itself change to read `Success! Reload the page after 5 seconds.`. | ||
3. After 5 seconds, the script will stop the server. Confirm by reloading the browser page after 5 seconds. | ||
4. You should see `Server stopped.` in your terminal output. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
"use strict"; | ||
|
||
const target = document.querySelector("#target"); | ||
|
||
target.classList.add("pass"); | ||
target.innerHTML = "Success! Reload the page after 5 seconds."; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
"use strict"; | ||
|
||
const Webpack = require("webpack"); | ||
const WebpackDevServer = require("../../../lib/Server"); | ||
const webpackConfig = require("./webpack.config"); | ||
|
||
const compiler = Webpack(webpackConfig); | ||
const devServerOptions = { ...webpackConfig.devServer, open: true }; | ||
const server = new WebpackDevServer(devServerOptions, compiler); | ||
|
||
server.startCallback(() => { | ||
console.log("Successfully started server on http://localhost:8080"); | ||
}); | ||
|
||
const stopServer = () => | ||
server.stopCallback(() => { | ||
console.log("Server stopped."); | ||
}); | ||
|
||
setTimeout(stopServer, 5000); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
"use strict"; | ||
|
||
// our setup function adds behind-the-scenes bits to the config that all of our | ||
// examples need | ||
const { setup } = require("../../util"); | ||
|
||
module.exports = setup({ | ||
context: __dirname, | ||
entry: "./app.js", | ||
output: { | ||
filename: "bundle.js", | ||
}, | ||
stats: { | ||
colors: true, | ||
}, | ||
}); |