webpack-dev-server 4.8.0 → 4.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/Server.js +3 -4
- package/package.json +1 -1
- package/types/lib/Server.d.ts +443 -294
package/lib/Server.js
CHANGED
|
@@ -25,7 +25,6 @@ const schema = require("./options.json");
|
|
|
25
25
|
/** @typedef {import("express").NextFunction} NextFunction */
|
|
26
26
|
/** @typedef {import("express").RequestHandler} ExpressRequestHandler */
|
|
27
27
|
/** @typedef {import("express").ErrorRequestHandler} ExpressErrorRequestHandler */
|
|
28
|
-
/** @typedef {import("anymatch").Matcher} AnymatchMatcher */
|
|
29
28
|
/** @typedef {import("chokidar").WatchOptions} WatchOptions */
|
|
30
29
|
/** @typedef {import("chokidar").FSWatcher} FSWatcher */
|
|
31
30
|
/** @typedef {import("connect-history-api-fallback").Options} ConnectHistoryApiFallbackOptions */
|
|
@@ -65,7 +64,7 @@ const schema = require("./options.json");
|
|
|
65
64
|
/**
|
|
66
65
|
* @typedef {Object} WatchFiles
|
|
67
66
|
* @property {string | string[]} paths
|
|
68
|
-
* @property {WatchOptions & { aggregateTimeout?: number, ignored?:
|
|
67
|
+
* @property {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [options]
|
|
69
68
|
*/
|
|
70
69
|
|
|
71
70
|
/**
|
|
@@ -74,7 +73,7 @@ const schema = require("./options.json");
|
|
|
74
73
|
* @property {string | string[]} [publicPath]
|
|
75
74
|
* @property {boolean | ServeIndexOptions} [serveIndex]
|
|
76
75
|
* @property {ServeStaticOptions} [staticOptions]
|
|
77
|
-
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?:
|
|
76
|
+
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [watch]
|
|
78
77
|
*/
|
|
79
78
|
|
|
80
79
|
/**
|
|
@@ -755,7 +754,7 @@ class Server {
|
|
|
755
754
|
// TODO remove `{}` after drop webpack v4 support
|
|
756
755
|
const compilerWatchOptions = compilerOptions.watchOptions || {};
|
|
757
756
|
/**
|
|
758
|
-
* @param {WatchOptions & { aggregateTimeout?: number, ignored?:
|
|
757
|
+
* @param {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} watchOptions
|
|
759
758
|
* @returns {WatchOptions}
|
|
760
759
|
*/
|
|
761
760
|
const getWatchOptions = (watchOptions = {}) => {
|
package/package.json
CHANGED
package/types/lib/Server.d.ts
CHANGED
|
@@ -26,7 +26,6 @@ declare class Server {
|
|
|
26
26
|
/** @typedef {import("express").NextFunction} NextFunction */
|
|
27
27
|
/** @typedef {import("express").RequestHandler} ExpressRequestHandler */
|
|
28
28
|
/** @typedef {import("express").ErrorRequestHandler} ExpressErrorRequestHandler */
|
|
29
|
-
/** @typedef {import("anymatch").Matcher} AnymatchMatcher */
|
|
30
29
|
/** @typedef {import("chokidar").WatchOptions} WatchOptions */
|
|
31
30
|
/** @typedef {import("chokidar").FSWatcher} FSWatcher */
|
|
32
31
|
/** @typedef {import("connect-history-api-fallback").Options} ConnectHistoryApiFallbackOptions */
|
|
@@ -60,7 +59,7 @@ declare class Server {
|
|
|
60
59
|
/**
|
|
61
60
|
* @typedef {Object} WatchFiles
|
|
62
61
|
* @property {string | string[]} paths
|
|
63
|
-
* @property {WatchOptions & { aggregateTimeout?: number, ignored?:
|
|
62
|
+
* @property {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [options]
|
|
64
63
|
*/
|
|
65
64
|
/**
|
|
66
65
|
* @typedef {Object} Static
|
|
@@ -68,7 +67,7 @@ declare class Server {
|
|
|
68
67
|
* @property {string | string[]} [publicPath]
|
|
69
68
|
* @property {boolean | ServeIndexOptions} [serveIndex]
|
|
70
69
|
* @property {ServeStaticOptions} [staticOptions]
|
|
71
|
-
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?:
|
|
70
|
+
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [watch]
|
|
72
71
|
*/
|
|
73
72
|
/**
|
|
74
73
|
* @typedef {Object} NormalizedStatic
|
|
@@ -221,6 +220,144 @@ declare class Server {
|
|
|
221
220
|
simpleType: string;
|
|
222
221
|
};
|
|
223
222
|
"client-logging": {
|
|
223
|
+
/**
|
|
224
|
+
* @template Request, Response
|
|
225
|
+
* @typedef {import("webpack-dev-middleware").Options<Request, Response>} DevMiddlewareOptions
|
|
226
|
+
*/
|
|
227
|
+
/**
|
|
228
|
+
* @template Request, Response
|
|
229
|
+
* @typedef {import("webpack-dev-middleware").Context<Request, Response>} DevMiddlewareContext
|
|
230
|
+
*/
|
|
231
|
+
/**
|
|
232
|
+
* @typedef {"local-ip" | "local-ipv4" | "local-ipv6" | string} Host
|
|
233
|
+
*/
|
|
234
|
+
/**
|
|
235
|
+
* @typedef {number | string | "auto"} Port
|
|
236
|
+
*/
|
|
237
|
+
/**
|
|
238
|
+
* @typedef {Object} WatchFiles
|
|
239
|
+
* @property {string | string[]} paths
|
|
240
|
+
* @property {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [options]
|
|
241
|
+
*/
|
|
242
|
+
/**
|
|
243
|
+
* @typedef {Object} Static
|
|
244
|
+
* @property {string} [directory]
|
|
245
|
+
* @property {string | string[]} [publicPath]
|
|
246
|
+
* @property {boolean | ServeIndexOptions} [serveIndex]
|
|
247
|
+
* @property {ServeStaticOptions} [staticOptions]
|
|
248
|
+
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [watch]
|
|
249
|
+
*/
|
|
250
|
+
/**
|
|
251
|
+
* @typedef {Object} NormalizedStatic
|
|
252
|
+
* @property {string} directory
|
|
253
|
+
* @property {string[]} publicPath
|
|
254
|
+
* @property {false | ServeIndexOptions} serveIndex
|
|
255
|
+
* @property {ServeStaticOptions} staticOptions
|
|
256
|
+
* @property {false | WatchOptions} watch
|
|
257
|
+
*/
|
|
258
|
+
/**
|
|
259
|
+
* @typedef {Object} ServerConfiguration
|
|
260
|
+
* @property {"http" | "https" | "spdy" | string} [type]
|
|
261
|
+
* @property {ServerOptions} [options]
|
|
262
|
+
*/
|
|
263
|
+
/**
|
|
264
|
+
* @typedef {Object} WebSocketServerConfiguration
|
|
265
|
+
* @property {"sockjs" | "ws" | string | Function} [type]
|
|
266
|
+
* @property {Record<string, any>} [options]
|
|
267
|
+
*/
|
|
268
|
+
/**
|
|
269
|
+
* @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
|
|
270
|
+
*/
|
|
271
|
+
/**
|
|
272
|
+
* @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
|
|
273
|
+
*/
|
|
274
|
+
/**
|
|
275
|
+
* @typedef {{ implementation: WebSocketServer, clients: ClientConnection[] }} WebSocketServerImplementation
|
|
276
|
+
*/
|
|
277
|
+
/**
|
|
278
|
+
* @callback ByPass
|
|
279
|
+
* @param {Request} req
|
|
280
|
+
* @param {Response} res
|
|
281
|
+
* @param {ProxyConfigArrayItem} proxyConfig
|
|
282
|
+
*/
|
|
283
|
+
/**
|
|
284
|
+
* @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
|
|
285
|
+
*/
|
|
286
|
+
/**
|
|
287
|
+
* @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
|
|
288
|
+
*/
|
|
289
|
+
/**
|
|
290
|
+
* @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
|
|
291
|
+
*/
|
|
292
|
+
/**
|
|
293
|
+
* @typedef {Object} OpenApp
|
|
294
|
+
* @property {string} [name]
|
|
295
|
+
* @property {string[]} [arguments]
|
|
296
|
+
*/
|
|
297
|
+
/**
|
|
298
|
+
* @typedef {Object} Open
|
|
299
|
+
* @property {string | string[] | OpenApp} [app]
|
|
300
|
+
* @property {string | string[]} [target]
|
|
301
|
+
*/
|
|
302
|
+
/**
|
|
303
|
+
* @typedef {Object} NormalizedOpen
|
|
304
|
+
* @property {string} target
|
|
305
|
+
* @property {import("open").Options} options
|
|
306
|
+
*/
|
|
307
|
+
/**
|
|
308
|
+
* @typedef {Object} WebSocketURL
|
|
309
|
+
* @property {string} [hostname]
|
|
310
|
+
* @property {string} [password]
|
|
311
|
+
* @property {string} [pathname]
|
|
312
|
+
* @property {number | string} [port]
|
|
313
|
+
* @property {string} [protocol]
|
|
314
|
+
* @property {string} [username]
|
|
315
|
+
*/
|
|
316
|
+
/**
|
|
317
|
+
* @typedef {Object} ClientConfiguration
|
|
318
|
+
* @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
|
|
319
|
+
* @property {boolean | { warnings?: boolean, errors?: boolean }} [overlay]
|
|
320
|
+
* @property {boolean} [progress]
|
|
321
|
+
* @property {boolean | number} [reconnect]
|
|
322
|
+
* @property {"ws" | "sockjs" | string} [webSocketTransport]
|
|
323
|
+
* @property {string | WebSocketURL} [webSocketURL]
|
|
324
|
+
*/
|
|
325
|
+
/**
|
|
326
|
+
* @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
|
|
327
|
+
*/
|
|
328
|
+
/**
|
|
329
|
+
* @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
|
|
330
|
+
*/
|
|
331
|
+
/**
|
|
332
|
+
* @typedef {Object} Configuration
|
|
333
|
+
* @property {boolean | string} [ipc]
|
|
334
|
+
* @property {Host} [host]
|
|
335
|
+
* @property {Port} [port]
|
|
336
|
+
* @property {boolean | "only"} [hot]
|
|
337
|
+
* @property {boolean} [liveReload]
|
|
338
|
+
* @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
|
|
339
|
+
* @property {boolean} [compress]
|
|
340
|
+
* @property {boolean} [magicHtml]
|
|
341
|
+
* @property {"auto" | "all" | string | string[]} [allowedHosts]
|
|
342
|
+
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
|
|
343
|
+
* @property {boolean} [setupExitSignals]
|
|
344
|
+
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
|
|
345
|
+
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
|
|
346
|
+
* @property {boolean | string | Static | Array<string | Static>} [static]
|
|
347
|
+
* @property {boolean | ServerOptions} [https]
|
|
348
|
+
* @property {boolean} [http2]
|
|
349
|
+
* @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
|
|
350
|
+
* @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
|
|
351
|
+
* @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
|
|
352
|
+
* @property {boolean | string | Open | Array<string | Open>} [open]
|
|
353
|
+
* @property {boolean} [setupExitSignals]
|
|
354
|
+
* @property {boolean | ClientConfiguration} [client]
|
|
355
|
+
* @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
|
|
356
|
+
* @property {(devServer: Server) => void} [onAfterSetupMiddleware]
|
|
357
|
+
* @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
|
|
358
|
+
* @property {(devServer: Server) => void} [onListening]
|
|
359
|
+
* @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
|
|
360
|
+
*/
|
|
224
361
|
configs: {
|
|
225
362
|
type: string;
|
|
226
363
|
values: string[];
|
|
@@ -234,133 +371,6 @@ declare class Server {
|
|
|
234
371
|
};
|
|
235
372
|
"client-overlay": {
|
|
236
373
|
configs: {
|
|
237
|
-
/**
|
|
238
|
-
* @typedef {number | string | "auto"} Port
|
|
239
|
-
*/
|
|
240
|
-
/**
|
|
241
|
-
* @typedef {Object} WatchFiles
|
|
242
|
-
* @property {string | string[]} paths
|
|
243
|
-
* @property {WatchOptions & { aggregateTimeout?: number, ignored?: AnymatchMatcher | string[], poll?: number | boolean }} [options]
|
|
244
|
-
*/
|
|
245
|
-
/**
|
|
246
|
-
* @typedef {Object} Static
|
|
247
|
-
* @property {string} [directory]
|
|
248
|
-
* @property {string | string[]} [publicPath]
|
|
249
|
-
* @property {boolean | ServeIndexOptions} [serveIndex]
|
|
250
|
-
* @property {ServeStaticOptions} [staticOptions]
|
|
251
|
-
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: AnymatchMatcher | string[], poll?: number | boolean }} [watch]
|
|
252
|
-
*/
|
|
253
|
-
/**
|
|
254
|
-
* @typedef {Object} NormalizedStatic
|
|
255
|
-
* @property {string} directory
|
|
256
|
-
* @property {string[]} publicPath
|
|
257
|
-
* @property {false | ServeIndexOptions} serveIndex
|
|
258
|
-
* @property {ServeStaticOptions} staticOptions
|
|
259
|
-
* @property {false | WatchOptions} watch
|
|
260
|
-
*/
|
|
261
|
-
/**
|
|
262
|
-
* @typedef {Object} ServerConfiguration
|
|
263
|
-
* @property {"http" | "https" | "spdy" | string} [type]
|
|
264
|
-
* @property {ServerOptions} [options]
|
|
265
|
-
*/
|
|
266
|
-
/**
|
|
267
|
-
* @typedef {Object} WebSocketServerConfiguration
|
|
268
|
-
* @property {"sockjs" | "ws" | string | Function} [type]
|
|
269
|
-
* @property {Record<string, any>} [options]
|
|
270
|
-
*/
|
|
271
|
-
/**
|
|
272
|
-
* @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
|
|
273
|
-
*/
|
|
274
|
-
/**
|
|
275
|
-
* @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
|
|
276
|
-
*/
|
|
277
|
-
/**
|
|
278
|
-
* @typedef {{ implementation: WebSocketServer, clients: ClientConnection[] }} WebSocketServerImplementation
|
|
279
|
-
*/
|
|
280
|
-
/**
|
|
281
|
-
* @callback ByPass
|
|
282
|
-
* @param {Request} req
|
|
283
|
-
* @param {Response} res
|
|
284
|
-
* @param {ProxyConfigArrayItem} proxyConfig
|
|
285
|
-
*/
|
|
286
|
-
/**
|
|
287
|
-
* @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
|
|
288
|
-
*/
|
|
289
|
-
/**
|
|
290
|
-
* @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
|
|
291
|
-
*/
|
|
292
|
-
/**
|
|
293
|
-
* @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
|
|
294
|
-
*/
|
|
295
|
-
/**
|
|
296
|
-
* @typedef {Object} OpenApp
|
|
297
|
-
* @property {string} [name]
|
|
298
|
-
* @property {string[]} [arguments]
|
|
299
|
-
*/
|
|
300
|
-
/**
|
|
301
|
-
* @typedef {Object} Open
|
|
302
|
-
* @property {string | string[] | OpenApp} [app]
|
|
303
|
-
* @property {string | string[]} [target]
|
|
304
|
-
*/
|
|
305
|
-
/**
|
|
306
|
-
* @typedef {Object} NormalizedOpen
|
|
307
|
-
* @property {string} target
|
|
308
|
-
* @property {import("open").Options} options
|
|
309
|
-
*/
|
|
310
|
-
/**
|
|
311
|
-
* @typedef {Object} WebSocketURL
|
|
312
|
-
* @property {string} [hostname]
|
|
313
|
-
* @property {string} [password]
|
|
314
|
-
* @property {string} [pathname]
|
|
315
|
-
* @property {number | string} [port]
|
|
316
|
-
* @property {string} [protocol]
|
|
317
|
-
* @property {string} [username]
|
|
318
|
-
*/
|
|
319
|
-
/**
|
|
320
|
-
* @typedef {Object} ClientConfiguration
|
|
321
|
-
* @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
|
|
322
|
-
* @property {boolean | { warnings?: boolean, errors?: boolean }} [overlay]
|
|
323
|
-
* @property {boolean} [progress]
|
|
324
|
-
* @property {boolean | number} [reconnect]
|
|
325
|
-
* @property {"ws" | "sockjs" | string} [webSocketTransport]
|
|
326
|
-
* @property {string | WebSocketURL} [webSocketURL]
|
|
327
|
-
*/
|
|
328
|
-
/**
|
|
329
|
-
* @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
|
|
330
|
-
*/
|
|
331
|
-
/**
|
|
332
|
-
* @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
|
|
333
|
-
*/
|
|
334
|
-
/**
|
|
335
|
-
* @typedef {Object} Configuration
|
|
336
|
-
* @property {boolean | string} [ipc]
|
|
337
|
-
* @property {Host} [host]
|
|
338
|
-
* @property {Port} [port]
|
|
339
|
-
* @property {boolean | "only"} [hot]
|
|
340
|
-
* @property {boolean} [liveReload]
|
|
341
|
-
* @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
|
|
342
|
-
* @property {boolean} [compress]
|
|
343
|
-
* @property {boolean} [magicHtml]
|
|
344
|
-
* @property {"auto" | "all" | string | string[]} [allowedHosts]
|
|
345
|
-
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
|
|
346
|
-
* @property {boolean} [setupExitSignals]
|
|
347
|
-
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
|
|
348
|
-
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
|
|
349
|
-
* @property {boolean | string | Static | Array<string | Static>} [static]
|
|
350
|
-
* @property {boolean | ServerOptions} [https]
|
|
351
|
-
* @property {boolean} [http2]
|
|
352
|
-
* @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
|
|
353
|
-
* @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
|
|
354
|
-
* @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
|
|
355
|
-
* @property {boolean | string | Open | Array<string | Open>} [open]
|
|
356
|
-
* @property {boolean} [setupExitSignals]
|
|
357
|
-
* @property {boolean | ClientConfiguration} [client]
|
|
358
|
-
* @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
|
|
359
|
-
* @property {(devServer: Server) => void} [onAfterSetupMiddleware]
|
|
360
|
-
* @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
|
|
361
|
-
* @property {(devServer: Server) => void} [onListening]
|
|
362
|
-
* @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
|
|
363
|
-
*/
|
|
364
374
|
type: string;
|
|
365
375
|
multiple: boolean;
|
|
366
376
|
description: string;
|
|
@@ -443,6 +453,36 @@ declare class Server {
|
|
|
443
453
|
path: string;
|
|
444
454
|
}
|
|
445
455
|
)[];
|
|
456
|
+
/**
|
|
457
|
+
* @typedef {Object} Configuration
|
|
458
|
+
* @property {boolean | string} [ipc]
|
|
459
|
+
* @property {Host} [host]
|
|
460
|
+
* @property {Port} [port]
|
|
461
|
+
* @property {boolean | "only"} [hot]
|
|
462
|
+
* @property {boolean} [liveReload]
|
|
463
|
+
* @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
|
|
464
|
+
* @property {boolean} [compress]
|
|
465
|
+
* @property {boolean} [magicHtml]
|
|
466
|
+
* @property {"auto" | "all" | string | string[]} [allowedHosts]
|
|
467
|
+
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
|
|
468
|
+
* @property {boolean} [setupExitSignals]
|
|
469
|
+
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
|
|
470
|
+
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
|
|
471
|
+
* @property {boolean | string | Static | Array<string | Static>} [static]
|
|
472
|
+
* @property {boolean | ServerOptions} [https]
|
|
473
|
+
* @property {boolean} [http2]
|
|
474
|
+
* @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
|
|
475
|
+
* @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
|
|
476
|
+
* @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
|
|
477
|
+
* @property {boolean | string | Open | Array<string | Open>} [open]
|
|
478
|
+
* @property {boolean} [setupExitSignals]
|
|
479
|
+
* @property {boolean | ClientConfiguration} [client]
|
|
480
|
+
* @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
|
|
481
|
+
* @property {(devServer: Server) => void} [onAfterSetupMiddleware]
|
|
482
|
+
* @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
|
|
483
|
+
* @property {(devServer: Server) => void} [onListening]
|
|
484
|
+
* @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
|
|
485
|
+
*/
|
|
446
486
|
description: string;
|
|
447
487
|
simpleType: string;
|
|
448
488
|
multiple: boolean;
|
|
@@ -508,7 +548,7 @@ declare class Server {
|
|
|
508
548
|
description: string;
|
|
509
549
|
multiple: boolean;
|
|
510
550
|
path: string;
|
|
511
|
-
|
|
551
|
+
type: string;
|
|
512
552
|
values: string[];
|
|
513
553
|
}
|
|
514
554
|
| {
|
|
@@ -518,6 +558,10 @@ declare class Server {
|
|
|
518
558
|
type: string;
|
|
519
559
|
}
|
|
520
560
|
)[];
|
|
561
|
+
/**
|
|
562
|
+
* @private
|
|
563
|
+
* @type {{ name: string | symbol, listener: (...args: any[]) => void}[] }}
|
|
564
|
+
*/
|
|
521
565
|
description: string;
|
|
522
566
|
multiple: boolean;
|
|
523
567
|
simpleType: string;
|
|
@@ -531,15 +575,8 @@ declare class Server {
|
|
|
531
575
|
type: string;
|
|
532
576
|
multiple: boolean;
|
|
533
577
|
description: string;
|
|
534
|
-
/**
|
|
535
|
-
* @type {Socket[]}
|
|
536
|
-
*/
|
|
537
578
|
path: string;
|
|
538
579
|
}[];
|
|
539
|
-
/**
|
|
540
|
-
* @private
|
|
541
|
-
* @type {string | undefined}
|
|
542
|
-
*/
|
|
543
580
|
description: string;
|
|
544
581
|
simpleType: string;
|
|
545
582
|
multiple: boolean;
|
|
@@ -595,6 +632,10 @@ declare class Server {
|
|
|
595
632
|
multiple: boolean;
|
|
596
633
|
description: string;
|
|
597
634
|
negatedDescription: string;
|
|
635
|
+
/**
|
|
636
|
+
* @param {"v4" | "v6"} family
|
|
637
|
+
* @returns {string | undefined}
|
|
638
|
+
*/
|
|
598
639
|
path: string;
|
|
599
640
|
}
|
|
600
641
|
| {
|
|
@@ -621,6 +662,10 @@ declare class Server {
|
|
|
621
662
|
simpleType: string;
|
|
622
663
|
multiple: boolean;
|
|
623
664
|
};
|
|
665
|
+
/**
|
|
666
|
+
* @param {Port} port
|
|
667
|
+
* @returns {Promise<number | string>}
|
|
668
|
+
*/
|
|
624
669
|
https: {
|
|
625
670
|
configs: {
|
|
626
671
|
type: string;
|
|
@@ -640,6 +685,9 @@ declare class Server {
|
|
|
640
685
|
description: string;
|
|
641
686
|
path: string;
|
|
642
687
|
}[];
|
|
688
|
+
/**
|
|
689
|
+
* @type {string | undefined}
|
|
690
|
+
*/
|
|
643
691
|
description: string;
|
|
644
692
|
simpleType: string;
|
|
645
693
|
multiple: boolean;
|
|
@@ -671,11 +719,10 @@ declare class Server {
|
|
|
671
719
|
description: string;
|
|
672
720
|
multiple: boolean;
|
|
673
721
|
path: string;
|
|
674
|
-
type: string;
|
|
722
|
+
/** @type {WebSocketURL} */ type: string;
|
|
675
723
|
}[];
|
|
676
724
|
description: string;
|
|
677
725
|
multiple: boolean;
|
|
678
|
-
/** @type {{ type: WebSocketServerConfiguration["type"], options: NonNullable<WebSocketServerConfiguration["options"]> }} */
|
|
679
726
|
simpleType: string;
|
|
680
727
|
};
|
|
681
728
|
"https-cert": {
|
|
@@ -689,7 +736,6 @@ declare class Server {
|
|
|
689
736
|
simpleType: string;
|
|
690
737
|
multiple: boolean;
|
|
691
738
|
};
|
|
692
|
-
/** @type {ServerConfiguration} */
|
|
693
739
|
"https-cert-reset": {
|
|
694
740
|
configs: {
|
|
695
741
|
description: string;
|
|
@@ -716,7 +762,7 @@ declare class Server {
|
|
|
716
762
|
configs: {
|
|
717
763
|
description: string;
|
|
718
764
|
multiple: boolean;
|
|
719
|
-
|
|
765
|
+
path: string;
|
|
720
766
|
type: string;
|
|
721
767
|
}[];
|
|
722
768
|
description: string;
|
|
@@ -738,7 +784,7 @@ declare class Server {
|
|
|
738
784
|
configs: {
|
|
739
785
|
description: string;
|
|
740
786
|
multiple: boolean;
|
|
741
|
-
|
|
787
|
+
path: string;
|
|
742
788
|
type: string;
|
|
743
789
|
}[];
|
|
744
790
|
description: string;
|
|
@@ -800,7 +846,7 @@ declare class Server {
|
|
|
800
846
|
}
|
|
801
847
|
| {
|
|
802
848
|
type: string;
|
|
803
|
-
values: boolean[];
|
|
849
|
+
/** @type {Object<string,string>} */ values: boolean[];
|
|
804
850
|
multiple: boolean;
|
|
805
851
|
description: string;
|
|
806
852
|
path: string;
|
|
@@ -831,7 +877,7 @@ declare class Server {
|
|
|
831
877
|
path: string;
|
|
832
878
|
}[];
|
|
833
879
|
description: string;
|
|
834
|
-
|
|
880
|
+
simpleType: string;
|
|
835
881
|
multiple: boolean;
|
|
836
882
|
};
|
|
837
883
|
open: {
|
|
@@ -865,10 +911,6 @@ declare class Server {
|
|
|
865
911
|
simpleType: string;
|
|
866
912
|
multiple: boolean;
|
|
867
913
|
};
|
|
868
|
-
/**
|
|
869
|
-
* @private
|
|
870
|
-
* @returns {Promise<void>}
|
|
871
|
-
*/
|
|
872
914
|
"open-app-name": {
|
|
873
915
|
configs: {
|
|
874
916
|
type: string;
|
|
@@ -928,7 +970,7 @@ declare class Server {
|
|
|
928
970
|
configs: (
|
|
929
971
|
| {
|
|
930
972
|
type: string;
|
|
931
|
-
|
|
973
|
+
multiple: boolean;
|
|
932
974
|
description: string;
|
|
933
975
|
path: string;
|
|
934
976
|
}
|
|
@@ -1109,9 +1151,8 @@ declare class Server {
|
|
|
1109
1151
|
}[];
|
|
1110
1152
|
description: string;
|
|
1111
1153
|
multiple: boolean;
|
|
1112
|
-
simpleType: string
|
|
1154
|
+
simpleType: string;
|
|
1113
1155
|
};
|
|
1114
|
-
/** @type {Array<keyof ServerOptions>} */
|
|
1115
1156
|
static: {
|
|
1116
1157
|
configs: (
|
|
1117
1158
|
| {
|
|
@@ -1129,10 +1170,9 @@ declare class Server {
|
|
|
1129
1170
|
}
|
|
1130
1171
|
)[];
|
|
1131
1172
|
description: string;
|
|
1132
|
-
|
|
1133
|
-
multiple: boolean
|
|
1173
|
+
simpleType: string;
|
|
1174
|
+
multiple: boolean;
|
|
1134
1175
|
};
|
|
1135
|
-
/** @type {ServerOptions} */
|
|
1136
1176
|
"static-directory": {
|
|
1137
1177
|
configs: {
|
|
1138
1178
|
type: string;
|
|
@@ -1159,7 +1199,7 @@ declare class Server {
|
|
|
1159
1199
|
configs: {
|
|
1160
1200
|
type: string;
|
|
1161
1201
|
multiple: boolean;
|
|
1162
|
-
|
|
1202
|
+
description: string;
|
|
1163
1203
|
path: string;
|
|
1164
1204
|
}[];
|
|
1165
1205
|
description: string;
|
|
@@ -1244,7 +1284,6 @@ declare class Server {
|
|
|
1244
1284
|
description: string;
|
|
1245
1285
|
multiple: boolean;
|
|
1246
1286
|
path: string;
|
|
1247
|
-
/** @type {ServerOptions & { cacert?: ServerOptions["ca"] }} */
|
|
1248
1287
|
type: string;
|
|
1249
1288
|
}
|
|
1250
1289
|
)[];
|
|
@@ -1363,6 +1402,151 @@ declare class Server {
|
|
|
1363
1402
|
logging: {
|
|
1364
1403
|
$ref: string;
|
|
1365
1404
|
};
|
|
1405
|
+
/** @typedef {import("serve-static").ServeStaticOptions} ServeStaticOptions */
|
|
1406
|
+
/** @typedef {import("ipaddr.js").IPv4} IPv4 */
|
|
1407
|
+
/** @typedef {import("ipaddr.js").IPv6} IPv6 */
|
|
1408
|
+
/** @typedef {import("net").Socket} Socket */
|
|
1409
|
+
/** @typedef {import("http").IncomingMessage} IncomingMessage */
|
|
1410
|
+
/** @typedef {import("open").Options} OpenOptions */
|
|
1411
|
+
/** @typedef {import("https").ServerOptions & { spdy?: { plain?: boolean | undefined, ssl?: boolean | undefined, 'x-forwarded-for'?: string | undefined, protocol?: string | undefined, protocols?: string[] | undefined }}} ServerOptions */
|
|
1412
|
+
/**
|
|
1413
|
+
* @template Request, Response
|
|
1414
|
+
* @typedef {import("webpack-dev-middleware").Options<Request, Response>} DevMiddlewareOptions
|
|
1415
|
+
*/
|
|
1416
|
+
/**
|
|
1417
|
+
* @template Request, Response
|
|
1418
|
+
* @typedef {import("webpack-dev-middleware").Context<Request, Response>} DevMiddlewareContext
|
|
1419
|
+
*/
|
|
1420
|
+
/**
|
|
1421
|
+
* @typedef {"local-ip" | "local-ipv4" | "local-ipv6" | string} Host
|
|
1422
|
+
*/
|
|
1423
|
+
/**
|
|
1424
|
+
* @typedef {number | string | "auto"} Port
|
|
1425
|
+
*/
|
|
1426
|
+
/**
|
|
1427
|
+
* @typedef {Object} WatchFiles
|
|
1428
|
+
* @property {string | string[]} paths
|
|
1429
|
+
* @property {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [options]
|
|
1430
|
+
*/
|
|
1431
|
+
/**
|
|
1432
|
+
* @typedef {Object} Static
|
|
1433
|
+
* @property {string} [directory]
|
|
1434
|
+
* @property {string | string[]} [publicPath]
|
|
1435
|
+
* @property {boolean | ServeIndexOptions} [serveIndex]
|
|
1436
|
+
* @property {ServeStaticOptions} [staticOptions]
|
|
1437
|
+
* @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [watch]
|
|
1438
|
+
*/
|
|
1439
|
+
/**
|
|
1440
|
+
* @typedef {Object} NormalizedStatic
|
|
1441
|
+
* @property {string} directory
|
|
1442
|
+
* @property {string[]} publicPath
|
|
1443
|
+
* @property {false | ServeIndexOptions} serveIndex
|
|
1444
|
+
* @property {ServeStaticOptions} staticOptions
|
|
1445
|
+
* @property {false | WatchOptions} watch
|
|
1446
|
+
*/
|
|
1447
|
+
/**
|
|
1448
|
+
* @typedef {Object} ServerConfiguration
|
|
1449
|
+
* @property {"http" | "https" | "spdy" | string} [type]
|
|
1450
|
+
* @property {ServerOptions} [options]
|
|
1451
|
+
*/
|
|
1452
|
+
/**
|
|
1453
|
+
* @typedef {Object} WebSocketServerConfiguration
|
|
1454
|
+
* @property {"sockjs" | "ws" | string | Function} [type]
|
|
1455
|
+
* @property {Record<string, any>} [options]
|
|
1456
|
+
*/
|
|
1457
|
+
/**
|
|
1458
|
+
* @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
|
|
1459
|
+
*/
|
|
1460
|
+
/**
|
|
1461
|
+
* @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
|
|
1462
|
+
*/
|
|
1463
|
+
/**
|
|
1464
|
+
* @typedef {{ implementation: WebSocketServer, clients: ClientConnection[] }} WebSocketServerImplementation
|
|
1465
|
+
*/
|
|
1466
|
+
/**
|
|
1467
|
+
* @callback ByPass
|
|
1468
|
+
* @param {Request} req
|
|
1469
|
+
* @param {Response} res
|
|
1470
|
+
* @param {ProxyConfigArrayItem} proxyConfig
|
|
1471
|
+
*/
|
|
1472
|
+
/**
|
|
1473
|
+
* @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
|
|
1474
|
+
*/
|
|
1475
|
+
/**
|
|
1476
|
+
* @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
|
|
1477
|
+
*/
|
|
1478
|
+
/**
|
|
1479
|
+
* @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
|
|
1480
|
+
*/
|
|
1481
|
+
/**
|
|
1482
|
+
* @typedef {Object} OpenApp
|
|
1483
|
+
* @property {string} [name]
|
|
1484
|
+
* @property {string[]} [arguments]
|
|
1485
|
+
*/
|
|
1486
|
+
/**
|
|
1487
|
+
* @typedef {Object} Open
|
|
1488
|
+
* @property {string | string[] | OpenApp} [app]
|
|
1489
|
+
* @property {string | string[]} [target]
|
|
1490
|
+
*/
|
|
1491
|
+
/**
|
|
1492
|
+
* @typedef {Object} NormalizedOpen
|
|
1493
|
+
* @property {string} target
|
|
1494
|
+
* @property {import("open").Options} options
|
|
1495
|
+
*/
|
|
1496
|
+
/**
|
|
1497
|
+
* @typedef {Object} WebSocketURL
|
|
1498
|
+
* @property {string} [hostname]
|
|
1499
|
+
* @property {string} [password]
|
|
1500
|
+
* @property {string} [pathname]
|
|
1501
|
+
* @property {number | string} [port]
|
|
1502
|
+
* @property {string} [protocol]
|
|
1503
|
+
* @property {string} [username]
|
|
1504
|
+
*/
|
|
1505
|
+
/**
|
|
1506
|
+
* @typedef {Object} ClientConfiguration
|
|
1507
|
+
* @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
|
|
1508
|
+
* @property {boolean | { warnings?: boolean, errors?: boolean }} [overlay]
|
|
1509
|
+
* @property {boolean} [progress]
|
|
1510
|
+
* @property {boolean | number} [reconnect]
|
|
1511
|
+
* @property {"ws" | "sockjs" | string} [webSocketTransport]
|
|
1512
|
+
* @property {string | WebSocketURL} [webSocketURL]
|
|
1513
|
+
*/
|
|
1514
|
+
/**
|
|
1515
|
+
* @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
|
|
1516
|
+
*/
|
|
1517
|
+
/**
|
|
1518
|
+
* @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
|
|
1519
|
+
*/
|
|
1520
|
+
/**
|
|
1521
|
+
* @typedef {Object} Configuration
|
|
1522
|
+
* @property {boolean | string} [ipc]
|
|
1523
|
+
* @property {Host} [host]
|
|
1524
|
+
* @property {Port} [port]
|
|
1525
|
+
* @property {boolean | "only"} [hot]
|
|
1526
|
+
* @property {boolean} [liveReload]
|
|
1527
|
+
* @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
|
|
1528
|
+
* @property {boolean} [compress]
|
|
1529
|
+
* @property {boolean} [magicHtml]
|
|
1530
|
+
* @property {"auto" | "all" | string | string[]} [allowedHosts]
|
|
1531
|
+
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
|
|
1532
|
+
* @property {boolean} [setupExitSignals]
|
|
1533
|
+
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
|
|
1534
|
+
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
|
|
1535
|
+
* @property {boolean | string | Static | Array<string | Static>} [static]
|
|
1536
|
+
* @property {boolean | ServerOptions} [https]
|
|
1537
|
+
* @property {boolean} [http2]
|
|
1538
|
+
* @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
|
|
1539
|
+
* @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
|
|
1540
|
+
* @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
|
|
1541
|
+
* @property {boolean | string | Open | Array<string | Open>} [open]
|
|
1542
|
+
* @property {boolean} [setupExitSignals]
|
|
1543
|
+
* @property {boolean | ClientConfiguration} [client]
|
|
1544
|
+
* @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
|
|
1545
|
+
* @property {(devServer: Server) => void} [onAfterSetupMiddleware]
|
|
1546
|
+
* @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
|
|
1547
|
+
* @property {(devServer: Server) => void} [onListening]
|
|
1548
|
+
* @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
|
|
1549
|
+
*/
|
|
1366
1550
|
overlay: {
|
|
1367
1551
|
$ref: string;
|
|
1368
1552
|
};
|
|
@@ -1413,117 +1597,6 @@ declare class Server {
|
|
|
1413
1597
|
};
|
|
1414
1598
|
};
|
|
1415
1599
|
warnings: {
|
|
1416
|
-
/**
|
|
1417
|
-
* @typedef {Object} NormalizedStatic
|
|
1418
|
-
* @property {string} directory
|
|
1419
|
-
* @property {string[]} publicPath
|
|
1420
|
-
* @property {false | ServeIndexOptions} serveIndex
|
|
1421
|
-
* @property {ServeStaticOptions} staticOptions
|
|
1422
|
-
* @property {false | WatchOptions} watch
|
|
1423
|
-
*/
|
|
1424
|
-
/**
|
|
1425
|
-
* @typedef {Object} ServerConfiguration
|
|
1426
|
-
* @property {"http" | "https" | "spdy" | string} [type]
|
|
1427
|
-
* @property {ServerOptions} [options]
|
|
1428
|
-
*/
|
|
1429
|
-
/**
|
|
1430
|
-
* @typedef {Object} WebSocketServerConfiguration
|
|
1431
|
-
* @property {"sockjs" | "ws" | string | Function} [type]
|
|
1432
|
-
* @property {Record<string, any>} [options]
|
|
1433
|
-
*/
|
|
1434
|
-
/**
|
|
1435
|
-
* @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
|
|
1436
|
-
*/
|
|
1437
|
-
/**
|
|
1438
|
-
* @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
|
|
1439
|
-
*/
|
|
1440
|
-
/**
|
|
1441
|
-
* @typedef {{ implementation: WebSocketServer, clients: ClientConnection[] }} WebSocketServerImplementation
|
|
1442
|
-
*/
|
|
1443
|
-
/**
|
|
1444
|
-
* @callback ByPass
|
|
1445
|
-
* @param {Request} req
|
|
1446
|
-
* @param {Response} res
|
|
1447
|
-
* @param {ProxyConfigArrayItem} proxyConfig
|
|
1448
|
-
*/
|
|
1449
|
-
/**
|
|
1450
|
-
* @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
|
|
1451
|
-
*/
|
|
1452
|
-
/**
|
|
1453
|
-
* @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
|
|
1454
|
-
*/
|
|
1455
|
-
/**
|
|
1456
|
-
* @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
|
|
1457
|
-
*/
|
|
1458
|
-
/**
|
|
1459
|
-
* @typedef {Object} OpenApp
|
|
1460
|
-
* @property {string} [name]
|
|
1461
|
-
* @property {string[]} [arguments]
|
|
1462
|
-
*/
|
|
1463
|
-
/**
|
|
1464
|
-
* @typedef {Object} Open
|
|
1465
|
-
* @property {string | string[] | OpenApp} [app]
|
|
1466
|
-
* @property {string | string[]} [target]
|
|
1467
|
-
*/
|
|
1468
|
-
/**
|
|
1469
|
-
* @typedef {Object} NormalizedOpen
|
|
1470
|
-
* @property {string} target
|
|
1471
|
-
* @property {import("open").Options} options
|
|
1472
|
-
*/
|
|
1473
|
-
/**
|
|
1474
|
-
* @typedef {Object} WebSocketURL
|
|
1475
|
-
* @property {string} [hostname]
|
|
1476
|
-
* @property {string} [password]
|
|
1477
|
-
* @property {string} [pathname]
|
|
1478
|
-
* @property {number | string} [port]
|
|
1479
|
-
* @property {string} [protocol]
|
|
1480
|
-
* @property {string} [username]
|
|
1481
|
-
*/
|
|
1482
|
-
/**
|
|
1483
|
-
* @typedef {Object} ClientConfiguration
|
|
1484
|
-
* @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
|
|
1485
|
-
* @property {boolean | { warnings?: boolean, errors?: boolean }} [overlay]
|
|
1486
|
-
* @property {boolean} [progress]
|
|
1487
|
-
* @property {boolean | number} [reconnect]
|
|
1488
|
-
* @property {"ws" | "sockjs" | string} [webSocketTransport]
|
|
1489
|
-
* @property {string | WebSocketURL} [webSocketURL]
|
|
1490
|
-
*/
|
|
1491
|
-
/**
|
|
1492
|
-
* @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
|
|
1493
|
-
*/
|
|
1494
|
-
/**
|
|
1495
|
-
* @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
|
|
1496
|
-
*/
|
|
1497
|
-
/**
|
|
1498
|
-
* @typedef {Object} Configuration
|
|
1499
|
-
* @property {boolean | string} [ipc]
|
|
1500
|
-
* @property {Host} [host]
|
|
1501
|
-
* @property {Port} [port]
|
|
1502
|
-
* @property {boolean | "only"} [hot]
|
|
1503
|
-
* @property {boolean} [liveReload]
|
|
1504
|
-
* @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
|
|
1505
|
-
* @property {boolean} [compress]
|
|
1506
|
-
* @property {boolean} [magicHtml]
|
|
1507
|
-
* @property {"auto" | "all" | string | string[]} [allowedHosts]
|
|
1508
|
-
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
|
|
1509
|
-
* @property {boolean} [setupExitSignals]
|
|
1510
|
-
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
|
|
1511
|
-
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
|
|
1512
|
-
* @property {boolean | string | Static | Array<string | Static>} [static]
|
|
1513
|
-
* @property {boolean | ServerOptions} [https]
|
|
1514
|
-
* @property {boolean} [http2]
|
|
1515
|
-
* @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
|
|
1516
|
-
* @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
|
|
1517
|
-
* @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
|
|
1518
|
-
* @property {boolean | string | Open | Array<string | Open>} [open]
|
|
1519
|
-
* @property {boolean} [setupExitSignals]
|
|
1520
|
-
* @property {boolean | ClientConfiguration} [client]
|
|
1521
|
-
* @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
|
|
1522
|
-
* @property {(devServer: Server) => void} [onAfterSetupMiddleware]
|
|
1523
|
-
* @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
|
|
1524
|
-
* @property {(devServer: Server) => void} [onListening]
|
|
1525
|
-
* @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
|
|
1526
|
-
*/
|
|
1527
1600
|
description: string;
|
|
1528
1601
|
type: string;
|
|
1529
1602
|
cli: {
|
|
@@ -1548,6 +1621,90 @@ declare class Server {
|
|
|
1548
1621
|
ClientReconnect: {
|
|
1549
1622
|
description: string;
|
|
1550
1623
|
link: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* @callback ByPass
|
|
1626
|
+
* @param {Request} req
|
|
1627
|
+
* @param {Response} res
|
|
1628
|
+
* @param {ProxyConfigArrayItem} proxyConfig
|
|
1629
|
+
*/
|
|
1630
|
+
/**
|
|
1631
|
+
* @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
|
|
1632
|
+
*/
|
|
1633
|
+
/**
|
|
1634
|
+
* @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
|
|
1635
|
+
*/
|
|
1636
|
+
/**
|
|
1637
|
+
* @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
|
|
1638
|
+
*/
|
|
1639
|
+
/**
|
|
1640
|
+
* @typedef {Object} OpenApp
|
|
1641
|
+
* @property {string} [name]
|
|
1642
|
+
* @property {string[]} [arguments]
|
|
1643
|
+
*/
|
|
1644
|
+
/**
|
|
1645
|
+
* @typedef {Object} Open
|
|
1646
|
+
* @property {string | string[] | OpenApp} [app]
|
|
1647
|
+
* @property {string | string[]} [target]
|
|
1648
|
+
*/
|
|
1649
|
+
/**
|
|
1650
|
+
* @typedef {Object} NormalizedOpen
|
|
1651
|
+
* @property {string} target
|
|
1652
|
+
* @property {import("open").Options} options
|
|
1653
|
+
*/
|
|
1654
|
+
/**
|
|
1655
|
+
* @typedef {Object} WebSocketURL
|
|
1656
|
+
* @property {string} [hostname]
|
|
1657
|
+
* @property {string} [password]
|
|
1658
|
+
* @property {string} [pathname]
|
|
1659
|
+
* @property {number | string} [port]
|
|
1660
|
+
* @property {string} [protocol]
|
|
1661
|
+
* @property {string} [username]
|
|
1662
|
+
*/
|
|
1663
|
+
/**
|
|
1664
|
+
* @typedef {Object} ClientConfiguration
|
|
1665
|
+
* @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
|
|
1666
|
+
* @property {boolean | { warnings?: boolean, errors?: boolean }} [overlay]
|
|
1667
|
+
* @property {boolean} [progress]
|
|
1668
|
+
* @property {boolean | number} [reconnect]
|
|
1669
|
+
* @property {"ws" | "sockjs" | string} [webSocketTransport]
|
|
1670
|
+
* @property {string | WebSocketURL} [webSocketURL]
|
|
1671
|
+
*/
|
|
1672
|
+
/**
|
|
1673
|
+
* @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
|
|
1674
|
+
*/
|
|
1675
|
+
/**
|
|
1676
|
+
* @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
|
|
1677
|
+
*/
|
|
1678
|
+
/**
|
|
1679
|
+
* @typedef {Object} Configuration
|
|
1680
|
+
* @property {boolean | string} [ipc]
|
|
1681
|
+
* @property {Host} [host]
|
|
1682
|
+
* @property {Port} [port]
|
|
1683
|
+
* @property {boolean | "only"} [hot]
|
|
1684
|
+
* @property {boolean} [liveReload]
|
|
1685
|
+
* @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
|
|
1686
|
+
* @property {boolean} [compress]
|
|
1687
|
+
* @property {boolean} [magicHtml]
|
|
1688
|
+
* @property {"auto" | "all" | string | string[]} [allowedHosts]
|
|
1689
|
+
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
|
|
1690
|
+
* @property {boolean} [setupExitSignals]
|
|
1691
|
+
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
|
|
1692
|
+
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
|
|
1693
|
+
* @property {boolean | string | Static | Array<string | Static>} [static]
|
|
1694
|
+
* @property {boolean | ServerOptions} [https]
|
|
1695
|
+
* @property {boolean} [http2]
|
|
1696
|
+
* @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
|
|
1697
|
+
* @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
|
|
1698
|
+
* @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
|
|
1699
|
+
* @property {boolean | string | Open | Array<string | Open>} [open]
|
|
1700
|
+
* @property {boolean} [setupExitSignals]
|
|
1701
|
+
* @property {boolean | ClientConfiguration} [client]
|
|
1702
|
+
* @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
|
|
1703
|
+
* @property {(devServer: Server) => void} [onAfterSetupMiddleware]
|
|
1704
|
+
* @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
|
|
1705
|
+
* @property {(devServer: Server) => void} [onListening]
|
|
1706
|
+
* @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
|
|
1707
|
+
*/
|
|
1551
1708
|
anyOf: (
|
|
1552
1709
|
| {
|
|
1553
1710
|
type: string;
|
|
@@ -1600,6 +1757,9 @@ declare class Server {
|
|
|
1600
1757
|
description: string;
|
|
1601
1758
|
type: string;
|
|
1602
1759
|
};
|
|
1760
|
+
/**
|
|
1761
|
+
* @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
|
|
1762
|
+
*/
|
|
1603
1763
|
password: {
|
|
1604
1764
|
description: string;
|
|
1605
1765
|
type: string;
|
|
@@ -1713,6 +1873,10 @@ declare class Server {
|
|
|
1713
1873
|
}
|
|
1714
1874
|
| {
|
|
1715
1875
|
instanceof: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* @private
|
|
1878
|
+
* @type {RequestHandler[]}
|
|
1879
|
+
*/
|
|
1716
1880
|
type?: undefined;
|
|
1717
1881
|
items?: undefined;
|
|
1718
1882
|
}
|
|
@@ -1810,10 +1974,6 @@ declare class Server {
|
|
|
1810
1974
|
items?: undefined;
|
|
1811
1975
|
}
|
|
1812
1976
|
)[];
|
|
1813
|
-
/**
|
|
1814
|
-
* @param {"v4" | "v6"} family
|
|
1815
|
-
* @returns {string | undefined}
|
|
1816
|
-
*/
|
|
1817
1977
|
description: string;
|
|
1818
1978
|
};
|
|
1819
1979
|
key: {
|
|
@@ -1919,9 +2079,6 @@ declare class Server {
|
|
|
1919
2079
|
Headers: {
|
|
1920
2080
|
anyOf: (
|
|
1921
2081
|
| {
|
|
1922
|
-
/**
|
|
1923
|
-
* @type {string[]}
|
|
1924
|
-
*/
|
|
1925
2082
|
type: string;
|
|
1926
2083
|
items: {
|
|
1927
2084
|
$ref: string;
|
|
@@ -1957,13 +2114,13 @@ declare class Server {
|
|
|
1957
2114
|
}
|
|
1958
2115
|
| {
|
|
1959
2116
|
type: string;
|
|
1960
|
-
|
|
2117
|
+
description: string;
|
|
1961
2118
|
link: string;
|
|
1962
2119
|
cli?: undefined /** @typedef {import("express").Request} Request */;
|
|
1963
2120
|
}
|
|
1964
2121
|
)[];
|
|
1965
2122
|
description: string;
|
|
1966
|
-
link: string;
|
|
2123
|
+
/** @type {string} */ link: string;
|
|
1967
2124
|
};
|
|
1968
2125
|
Host: {
|
|
1969
2126
|
description: string;
|
|
@@ -1971,7 +2128,7 @@ declare class Server {
|
|
|
1971
2128
|
anyOf: (
|
|
1972
2129
|
| {
|
|
1973
2130
|
enum: string[];
|
|
1974
|
-
|
|
2131
|
+
type?: undefined;
|
|
1975
2132
|
minLength?: undefined;
|
|
1976
2133
|
}
|
|
1977
2134
|
| {
|
|
@@ -2110,12 +2267,6 @@ declare class Server {
|
|
|
2110
2267
|
}
|
|
2111
2268
|
| {
|
|
2112
2269
|
type: string;
|
|
2113
|
-
/**
|
|
2114
|
-
* prependEntry Method for webpack 4
|
|
2115
|
-
* @param {any} originalEntry
|
|
2116
|
-
* @param {any} newAdditionalEntries
|
|
2117
|
-
* @returns {any}
|
|
2118
|
-
*/
|
|
2119
2270
|
minLength: number;
|
|
2120
2271
|
items?: undefined;
|
|
2121
2272
|
minItems?: undefined;
|
|
@@ -2140,7 +2291,6 @@ declare class Server {
|
|
|
2140
2291
|
cli: {
|
|
2141
2292
|
description: string;
|
|
2142
2293
|
};
|
|
2143
|
-
/** @type {Object<string,string>} */
|
|
2144
2294
|
additionalProperties?: undefined;
|
|
2145
2295
|
properties?: undefined;
|
|
2146
2296
|
}
|
|
@@ -2196,7 +2346,7 @@ declare class Server {
|
|
|
2196
2346
|
}
|
|
2197
2347
|
| {
|
|
2198
2348
|
instanceof: string;
|
|
2199
|
-
type?: undefined;
|
|
2349
|
+
/** @type {string} */ type?: undefined;
|
|
2200
2350
|
}
|
|
2201
2351
|
)[];
|
|
2202
2352
|
};
|
|
@@ -2207,7 +2357,7 @@ declare class Server {
|
|
|
2207
2357
|
};
|
|
2208
2358
|
Server: {
|
|
2209
2359
|
anyOf: {
|
|
2210
|
-
$ref: string
|
|
2360
|
+
$ref: string /** @type {MultiCompiler} */;
|
|
2211
2361
|
}[];
|
|
2212
2362
|
link: string;
|
|
2213
2363
|
description: string;
|
|
@@ -2248,7 +2398,7 @@ declare class Server {
|
|
|
2248
2398
|
properties: {
|
|
2249
2399
|
passphrase: {
|
|
2250
2400
|
type: string;
|
|
2251
|
-
|
|
2401
|
+
description: string;
|
|
2252
2402
|
};
|
|
2253
2403
|
requestCert: {
|
|
2254
2404
|
type: string;
|
|
@@ -2375,7 +2525,7 @@ declare class Server {
|
|
|
2375
2525
|
}
|
|
2376
2526
|
| {
|
|
2377
2527
|
instanceof: string;
|
|
2378
|
-
|
|
2528
|
+
type?: undefined;
|
|
2379
2529
|
items?: undefined;
|
|
2380
2530
|
}
|
|
2381
2531
|
)[];
|
|
@@ -2641,7 +2791,7 @@ declare class Server {
|
|
|
2641
2791
|
$ref: string;
|
|
2642
2792
|
}[];
|
|
2643
2793
|
description: string;
|
|
2644
|
-
link: string
|
|
2794
|
+
link: string;
|
|
2645
2795
|
};
|
|
2646
2796
|
WebSocketServerType: {
|
|
2647
2797
|
enum: string[];
|
|
@@ -2700,6 +2850,7 @@ declare class Server {
|
|
|
2700
2850
|
$ref: string;
|
|
2701
2851
|
};
|
|
2702
2852
|
client: {
|
|
2853
|
+
/** @type {any} */
|
|
2703
2854
|
$ref: string;
|
|
2704
2855
|
};
|
|
2705
2856
|
compress: {
|
|
@@ -3098,7 +3249,6 @@ declare namespace Server {
|
|
|
3098
3249
|
NextFunction,
|
|
3099
3250
|
ExpressRequestHandler,
|
|
3100
3251
|
ExpressErrorRequestHandler,
|
|
3101
|
-
AnymatchMatcher,
|
|
3102
3252
|
WatchOptions,
|
|
3103
3253
|
FSWatcher,
|
|
3104
3254
|
ConnectHistoryApiFallbackOptions,
|
|
@@ -3237,7 +3387,6 @@ type Response = import("express").Response;
|
|
|
3237
3387
|
type NextFunction = import("express").NextFunction;
|
|
3238
3388
|
type ExpressRequestHandler = import("express").RequestHandler;
|
|
3239
3389
|
type ExpressErrorRequestHandler = import("express").ErrorRequestHandler;
|
|
3240
|
-
type AnymatchMatcher = import("anymatch").Matcher;
|
|
3241
3390
|
type WatchOptions = import("chokidar").WatchOptions;
|
|
3242
3391
|
type ConnectHistoryApiFallbackOptions =
|
|
3243
3392
|
import("connect-history-api-fallback").Options;
|
|
@@ -3270,7 +3419,7 @@ type WatchFiles = {
|
|
|
3270
3419
|
options?:
|
|
3271
3420
|
| (import("chokidar").WatchOptions & {
|
|
3272
3421
|
aggregateTimeout?: number | undefined;
|
|
3273
|
-
ignored?:
|
|
3422
|
+
ignored?: WatchOptions["ignored"];
|
|
3274
3423
|
poll?: number | boolean | undefined;
|
|
3275
3424
|
})
|
|
3276
3425
|
| undefined;
|
|
@@ -3286,7 +3435,7 @@ type Static = {
|
|
|
3286
3435
|
| boolean
|
|
3287
3436
|
| (import("chokidar").WatchOptions & {
|
|
3288
3437
|
aggregateTimeout?: number | undefined;
|
|
3289
|
-
ignored?:
|
|
3438
|
+
ignored?: WatchOptions["ignored"];
|
|
3290
3439
|
poll?: number | boolean | undefined;
|
|
3291
3440
|
})
|
|
3292
3441
|
| undefined;
|