Skip to content

fix: handle undefined options in Server constructor #5696

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
bjohansebas merged 3 commits into from
Jul 2, 2026
+28 −3
Merged

fix: handle undefined options in Server constructor #5696

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67e2a15
fix: handle undefined options in Server constructor
bjohansebas Jul 1, 2026
35b7d49
fix: ensure undefined options default to an empty object in Server co…
bjohansebas Jul 1, 2026
aa723d8
fixup!
bjohansebas Jul 2, 2026
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: 3 additions & 1 deletion lib/Server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,10 +337,12 @@ const pluginName = "webpack-dev-server";
*/
class Server {
/**
* @param {Configuration<A, S>} options options
* @param {Configuration<A, S> | undefined} options options
* @param {(Compiler | MultiCompiler)=} compiler compiler, omitted when the server is used as a plugin via `apply()`
*/
constructor(options, compiler) {
options ??= {};

Comment thread
Copilot marked this conversation as resolved.
Comment thread
bjohansebas marked this conversation as resolved.
validate(/** @type {Schema} */ (schema), options, {
name: "Dev Server",
baseDataPath: "options",
Expand Down
12 changes: 12 additions & 0 deletions test/e2e/api.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@ describe("API", () => {
});
});

describe("constructor options", () => {
it("should default `undefined` options to `{}`", async () => {
const compiler = webpack(config);
const server = new Server(undefined, compiler);

expect(server.options).toEqual({});

await server.start();
await server.stop();
});
Comment thread
Copilot marked this conversation as resolved.
Outdated
});

Comment thread
bjohansebas marked this conversation as resolved.
describe("latest async API", () => {
Comment thread
bjohansebas marked this conversation as resolved.
it("should work with async API", async (t) => {
const compiler = webpack(config);
Expand Down
4 changes: 2 additions & 2 deletions types/lib/Server.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1495,11 +1495,11 @@ declare class Server<
*/
private static isWebTarget;
/**
* @param {Configuration<A, S>} options options
* @param {Configuration<A, S> | undefined} options options
* @param {(Compiler | MultiCompiler)=} compiler compiler, omitted when the server is used as a plugin via `apply()`
*/
constructor(
options: Configuration<A, S>,
options: Configuration<A, S> | undefined,
compiler?: (Compiler | MultiCompiler) | undefined,
);
compiler:
Expand Down
Loading