Skip to content

Commit 4c3c4d6

Browse files
alexander-akaitalexander-akait
authored
chore: fix types (#4797)
1 parent 5a79c8e commit 4c3c4d6

File tree

2 files changed

+38
-56
lines changed

2 files changed

+38
-56
lines changed

‎lib/Server.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,6 @@ const schema = require("./options.json");
186186
* @property {boolean} [magicHtml]
187187
* @property {"auto" | "all" | string | string[]} [allowedHosts]
188188
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
189-
* @property {boolean} [setupExitSignals]
190189
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
191190
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
192191
* @property {boolean | string | Static | Array<string | Static>} [static]

‎types/lib/Server.d.ts

Lines changed: 38 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,6 @@ declare class Server {
162162
* @property {boolean} [magicHtml]
163163
* @property {"auto" | "all" | string | string[]} [allowedHosts]
164164
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
165-
* @property {boolean} [setupExitSignals]
166165
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
167166
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
168167
* @property {boolean | string | Static | Array<string | Static>} [static]
@@ -340,7 +339,6 @@ declare class Server {
340339
* @property {boolean} [magicHtml]
341340
* @property {"auto" | "all" | string | string[]} [allowedHosts]
342341
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
343-
* @property {boolean} [setupExitSignals]
344342
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
345343
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
346344
* @property {boolean | string | Static | Array<string | Static>} [static]
@@ -467,7 +465,6 @@ declare class Server {
467465
* @property {boolean} [magicHtml]
468466
* @property {"auto" | "all" | string | string[]} [allowedHosts]
469467
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
470-
* @property {boolean} [setupExitSignals]
471468
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
472469
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
473470
* @property {boolean | string | Static | Array<string | Static>} [static]
@@ -562,10 +559,6 @@ declare class Server {
562559
description: string;
563560
path: string;
564561
}[];
565-
/**
566-
* @param {Configuration | Compiler | MultiCompiler} options
567-
* @param {Compiler | MultiCompiler | Configuration} compiler
568-
*/
569562
description: string;
570563
simpleType: string;
571564
multiple: boolean;
@@ -591,19 +584,12 @@ declare class Server {
591584
description: string;
592585
simpleType: string;
593586
multiple: boolean;
594-
/**
595-
* @type {FSWatcher[]}
596-
*/
597587
};
598588
"client-web-socket-url-port": {
599589
configs: {
600590
type: string;
601591
multiple: boolean;
602592
description: string;
603-
/**
604-
* @private
605-
* @type {RequestHandler[]}
606-
*/
607593
path: string;
608594
}[];
609595
description: string;
@@ -766,13 +752,13 @@ declare class Server {
766752
"https-cacert-reset": {
767753
configs: {
768754
description: string;
755+
/** @type {string} */
769756
multiple: boolean;
770757
path: string;
771758
type: string;
772759
}[];
773760
description: string;
774761
multiple: boolean;
775-
/** @type {ServerConfiguration} */
776762
simpleType: string;
777763
};
778764
"https-cert": {
@@ -783,7 +769,7 @@ declare class Server {
783769
path: string;
784770
}[];
785771
description: string;
786-
/** @type {string} */ simpleType: string;
772+
simpleType: string;
787773
multiple: boolean;
788774
};
789775
"https-cert-reset": {
@@ -881,6 +867,12 @@ declare class Server {
881867
description: string;
882868
negatedDescription: string;
883869
path: string;
870+
/**
871+
* prependEntry Method for webpack 4
872+
* @param {any} originalEntry
873+
* @param {any} newAdditionalEntries
874+
* @returns {any}
875+
*/
884876
}[];
885877
description: string;
886878
simpleType: string;
@@ -906,7 +898,6 @@ declare class Server {
906898
simpleType: string;
907899
multiple: boolean;
908900
};
909-
/** @type {Object<string,string>} */
910901
"live-reload": {
911902
configs: {
912903
type: string;
@@ -915,6 +906,7 @@ declare class Server {
915906
negatedDescription: string;
916907
path: string;
917908
}[];
909+
/** @type {any} */
918910
description: string;
919911
simpleType: string;
920912
multiple: boolean;
@@ -936,7 +928,7 @@ declare class Server {
936928
| {
937929
type: string;
938930
multiple: boolean;
939-
description: string;
931+
/** @type {MultiCompiler} */ description: string;
940932
path: string;
941933
}
942934
| {
@@ -968,14 +960,14 @@ declare class Server {
968960
multiple: boolean;
969961
description: string;
970962
path: string;
971-
/**
972-
* @private
973-
* @returns {Promise<void>}
974-
*/
975963
}[];
976964
description: string;
977965
simpleType: string;
978966
multiple: boolean;
967+
/**
968+
* @param {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} watchOptions
969+
* @returns {WatchOptions}
970+
*/
979971
};
980972
"open-app-name-reset": {
981973
configs: {
@@ -1206,7 +1198,7 @@ declare class Server {
12061198
}[];
12071199
description: string;
12081200
multiple: boolean;
1209-
simpleType: string;
1201+
simpleType: string /** @type {ServerOptions} */;
12101202
};
12111203
static: {
12121204
configs: (
@@ -1219,7 +1211,7 @@ declare class Server {
12191211
| {
12201212
type: string;
12211213
multiple: boolean;
1222-
description: string;
1214+
/** @type {ServerOptions} */ description: string;
12231215
negatedDescription: string;
12241216
path: string;
12251217
}
@@ -1231,15 +1223,11 @@ declare class Server {
12311223
"static-directory": {
12321224
configs: {
12331225
type: string;
1234-
multiple: boolean;
1226+
/** @type {any} */ multiple: boolean;
12351227
description: string;
12361228
path: string;
12371229
}[];
12381230
description: string;
1239-
/**
1240-
* @param {string | Buffer | undefined} item
1241-
* @returns {string | Buffer | undefined}
1242-
*/
12431231
simpleType: string;
12441232
multiple: boolean;
12451233
};
@@ -1251,8 +1239,8 @@ declare class Server {
12511239
path: string;
12521240
}[];
12531241
description: string;
1254-
simpleType: string;
1255-
multiple: boolean /** @type {any} */;
1242+
/** @type {any} */ simpleType: string;
1243+
multiple: boolean;
12561244
};
12571245
"static-public-path-reset": {
12581246
configs: {
@@ -1369,7 +1357,7 @@ declare class Server {
13691357
description: string;
13701358
simpleType: string;
13711359
multiple: boolean;
1372-
};
1360+
} /** @type {ServerOptions} */;
13731361
};
13741362
readonly processArguments: (
13751363
args: Record<string, import("../bin/process-arguments").Argument>,
@@ -1588,7 +1576,6 @@ declare class Server {
15881576
* @property {boolean} [magicHtml]
15891577
* @property {"auto" | "all" | string | string[]} [allowedHosts]
15901578
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
1591-
* @property {boolean} [setupExitSignals]
15921579
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
15931580
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
15941581
* @property {boolean | string | Static | Array<string | Static>} [static]
@@ -1745,7 +1732,6 @@ declare class Server {
17451732
* @property {boolean} [magicHtml]
17461733
* @property {"auto" | "all" | string | string[]} [allowedHosts]
17471734
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
1748-
* @property {boolean} [setupExitSignals]
17491735
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
17501736
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
17511737
* @property {boolean | string | Static | Array<string | Static>} [static]
@@ -1813,7 +1799,6 @@ declare class Server {
18131799
* @property {boolean} [magicHtml]
18141800
* @property {"auto" | "all" | string | string[]} [allowedHosts]
18151801
* @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
1816-
* @property {boolean} [setupExitSignals]
18171802
* @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
18181803
* @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
18191804
* @property {boolean | string | Static | Array<string | Static>} [static]
@@ -1929,10 +1914,6 @@ declare class Server {
19291914
cli: {
19301915
negatedDescription: string;
19311916
};
1932-
/**
1933-
* @private
1934-
* @type {RequestHandler[]}
1935-
*/
19361917
};
19371918
ca: {
19381919
anyOf: (
@@ -2191,13 +2172,15 @@ declare class Server {
21912172
cli: {
21922173
negatedDescription: string;
21932174
};
2194-
description?: undefined;
2175+
/** @type {WebSocketURL} */ description?: undefined;
21952176
link?: undefined;
21962177
}
21972178
| {
21982179
type: string;
2199-
/** @type {WebSocketURL} */ description: string;
2180+
/** @type {ClientConfiguration} */
2181+
description: string;
22002182
link: string;
2183+
/** @type {{ type: WebSocketServerConfiguration["type"], options: NonNullable<WebSocketServerConfiguration["options"]> }} */
22012184
cli?: undefined /** @typedef {import("express").Request} Request */;
22022185
}
22032186
)[];
@@ -2210,7 +2193,7 @@ declare class Server {
22102193
anyOf: (
22112194
| {
22122195
enum: string[];
2213-
/** @type {ServerConfiguration} */ type?: undefined;
2196+
type?: undefined;
22142197
minLength?: undefined;
22152198
}
22162199
| {
@@ -2283,7 +2266,7 @@ declare class Server {
22832266
OnListening: {
22842267
instanceof: string;
22852268
description: string;
2286-
link: string;
2269+
/** @type {string} */ link: string;
22872270
};
22882271
Open: {
22892272
anyOf: (
@@ -2381,12 +2364,6 @@ declare class Server {
23812364
};
23822365
};
23832366
};
2384-
/**
2385-
* prependEntry Method for webpack 4
2386-
* @param {any} originalEntry
2387-
* @param {any} newAdditionalEntries
2388-
* @returns {any}
2389-
*/
23902367
OpenString: {
23912368
type: string;
23922369
minLength: number;
@@ -2441,7 +2418,6 @@ declare class Server {
24412418
}
24422419
)[];
24432420
description: string;
2444-
/** @type {any} */
24452421
link: string;
24462422
};
24472423
Server: {
@@ -2620,6 +2596,10 @@ declare class Server {
26202596
)[];
26212597
description: string;
26222598
};
2599+
/**
2600+
* @param {string | Static | undefined} [optionsForStatic]
2601+
* @returns {NormalizedStatic}
2602+
*/
26232603
key: {
26242604
anyOf: (
26252605
| {
@@ -2641,7 +2621,7 @@ declare class Server {
26412621
additionalProperties: boolean;
26422622
instanceof?: undefined;
26432623
}
2644-
)[];
2624+
)[] /** @type {NormalizedStatic} */;
26452625
};
26462626
instanceof?: undefined;
26472627
}
@@ -2905,7 +2885,7 @@ declare class Server {
29052885
};
29062886
};
29072887
WebSocketServerFunction: {
2908-
instanceof: string /** @type {ServerOptions} */;
2888+
instanceof: string;
29092889
};
29102890
WebSocketServerObject: {
29112891
type: string;
@@ -2940,6 +2920,10 @@ declare class Server {
29402920
};
29412921
client: {
29422922
$ref: string;
2923+
/**
2924+
* @param {string | Buffer | undefined} item
2925+
* @returns {string | Buffer | undefined}
2926+
*/
29432927
};
29442928
compress: {
29452929
$ref: string;
@@ -2974,15 +2958,14 @@ declare class Server {
29742958
magicHtml: {
29752959
$ref: string;
29762960
};
2977-
/** @type {any} */
29782961
onAfterSetupMiddleware: {
29792962
$ref: string;
29802963
};
29812964
onBeforeSetupMiddleware: {
29822965
$ref: string;
29832966
};
29842967
onListening: {
2985-
$ref: string;
2968+
$ref: string /** @type {ServerOptions} */;
29862969
};
29872970
open: {
29882971
$ref: string;
@@ -3405,7 +3388,6 @@ type Configuration = {
34053388
| boolean
34063389
| import("connect-history-api-fallback").Options
34073390
| undefined;
3408-
setupExitSignals?: boolean | undefined;
34093391
bonjour?:
34103392
| boolean
34113393
| Record<string, never>
@@ -3424,6 +3406,7 @@ type Configuration = {
34243406
webSocketServer?: string | boolean | WebSocketServerConfiguration | undefined;
34253407
proxy?: ProxyConfigArrayItem | ProxyConfigMap | ProxyConfigArray | undefined;
34263408
open?: string | boolean | Open | (string | Open)[] | undefined;
3409+
setupExitSignals?: boolean | undefined;
34273410
client?: boolean | ClientConfiguration | undefined;
34283411
headers?:
34293412
| Headers

0 commit comments

Comments
 (0)