docs: add start example (#3848)

examples/api/start/README.md

@@ -0,0 +1,34 @@
+# API: start
+
+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 `start` method. It instructs `webpack-dev-server` instance to stop watching for file changes.
+
+```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);
+
+const runServer = async () => {
+  console.log("Starting server...");
+  await server.start();
+};
+
+runServer();
+```
+
+Use the following command to run this example:
+
+```console
+node server.js
+```
+
+## What Should Happen
+
+1. Open `http://localhost:8080/` in your preferred browser.
+2. You should see the text on the page itself change to read `Success!`.

examples/api/start/app.js

@@ -0,0 +1,6 @@
+"use strict";
+
+const target = document.querySelector("#target");
+
+target.classList.add("pass");
+target.innerHTML = "Success!";

examples/api/start/server.js

@@ -0,0 +1,16 @@
+"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);
+
+const runServer = async () => {
+  console.log("Starting server...");
+  await server.start();
+};
+
+runServer();

examples/api/start/webpack.config.js

@@ -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,
+  },
+});