index.d.ts
96.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
// Type definitions for webpack 4.41
// Project: https://github.com/webpack/webpack
// Definitions by: Qubo <https://github.com/tkqubo>
// Benjamin Lim <https://github.com/bumbleblym>
// Boris Cherny <https://github.com/bcherny>
// Tommy Troy Lin <https://github.com/tommytroylin>
// Mohsen Azimi <https://github.com/mohsen1>
// Jonathan Creamer <https://github.com/jcreamer898>
// Alan Agius <https://github.com/alan-agius4>
// Dennis George <https://github.com/dennispg>
// Christophe Hurpeau <https://github.com/christophehurpeau>
// ZSkycat <https://github.com/ZSkycat>
// John Reilly <https://github.com/johnnyreilly>
// Ryan Waskiewicz <https://github.com/rwaskiewicz>
// Kyle Uehlein <https://github.com/kuehlein>
// Grgur Grisogono <https://github.com/grgur>
// Rubens Pinheiro Gonçalves Cavalcante <https://github.com/rubenspgcavalcante>
// Anders Kaseorg <https://github.com/andersk>
// Felix Haus <https://github.com/ofhouse>
// Daniel Chin <https://github.com/danielthank>
// Daiki Ihara <https://github.com/sasurau4>
// Dion Shi <https://github.com/dionshihk>
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Michał Grzegorzewski <https://github.com/spamshaker>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
/// <reference types="node" />
import { Hash as CryptoHash } from 'crypto';
import {
Tapable,
HookMap,
SyncBailHook,
SyncHook,
SyncLoopHook,
SyncWaterfallHook,
AsyncParallelBailHook,
AsyncParallelHook,
AsyncSeriesBailHook,
AsyncSeriesHook,
AsyncSeriesWaterfallHook,
} from '../tapable';
import * as UglifyJS from './uglify-js';
import * as anymatch from './anymatch';
import { RawSourceMap } from './source-map/source-map';
import { Source, ConcatSource } from '../webpack-sources';
export = webpack;
declare function webpack(
options:
| webpack.Configuration
| webpack.ConfigurationFactory,
handler: webpack.Compiler.Handler,
): webpack.Compiler.Watching | webpack.Compiler;
declare function webpack(options?: webpack.Configuration): webpack.Compiler;
declare function webpack(
options:
| webpack.Configuration[]
| webpack.MultiConfigurationFactory,
handler: webpack.MultiCompiler.Handler
): webpack.MultiWatching | webpack.MultiCompiler;
declare function webpack(options: webpack.Configuration[]): webpack.MultiCompiler;
declare namespace webpack {
/** Webpack package version. */
const version: string | undefined;
function webpack(
options:
| webpack.Configuration
| webpack.ConfigurationFactory,
handler: webpack.Compiler.Handler,
): webpack.Compiler.Watching | webpack.Compiler;
function webpack(options?: webpack.Configuration): webpack.Compiler;
function webpack(
options:
| webpack.Configuration[]
| webpack.MultiConfigurationFactory,
handler: webpack.MultiCompiler.Handler
): webpack.MultiWatching | webpack.MultiCompiler;
function webpack(options: webpack.Configuration[]): webpack.MultiCompiler;
function init(isWebpack5?: boolean): void;
function onWebpackInit(cb: Function): void;
interface Configuration {
/** Enable production optimizations or development hints. */
mode?: "development" | "production" | "none";
/** Name of the configuration. Used when loading multiple configurations. */
name?: string;
/**
* The base directory (absolute path!) for resolving the `entry` option.
* If `output.pathinfo` is set, the included pathinfo is shortened to this directory.
*/
context?: string;
entry?: string | string[] | Entry | EntryFunc;
/** Choose a style of source mapping to enhance the debugging process. These values can affect build and rebuild speed dramatically. */
devtool?: Options.Devtool;
/** Options affecting the output. */
output?: Output;
/** Options affecting the normal modules (NormalModuleFactory) */
module?: Module;
/** Options affecting the resolving of modules. */
resolve?: Resolve;
/** Like resolve but for loaders. */
resolveLoader?: ResolveLoader;
/**
* Specify dependencies that shouldn’t be resolved by webpack, but should become dependencies of the resulting bundle.
* The kind of the dependency depends on output.libraryTarget.
*/
externals?: ExternalsElement | ExternalsElement[];
/**
* - "web" Compile for usage in a browser-like environment (default).
* - "webworker" Compile as WebWorker.
* - "node" Compile for usage in a node.js-like environment (use require to load chunks).
* - "async-node" Compile for usage in a node.js-like environment (use fs and vm to load chunks async).
* - "node-webkit" Compile for usage in webkit, uses jsonp chunk loading but also supports builtin node.js modules plus require(“nw.gui”) (experimental)
* - "atom" Compile for usage in electron (formerly known as atom-shell), supports require for modules necessary to run Electron.
* - "electron-renderer" Compile for Electron for renderer process, providing a target using JsonpTemplatePlugin, FunctionModulePlugin for browser
* environments and NodeTargetPlugin and ExternalsPlugin for CommonJS and Electron built-in modules.
* - "electron-preload" Compile for Electron for renderer process, providing a target using NodeTemplatePlugin with asyncChunkLoading set to true,
* FunctionModulePlugin for browser environments and NodeTargetPlugin and ExternalsPlugin for CommonJS and Electron built-in modules.
* - "electron-main" Compile for Electron for main process.
* - "atom" Alias for electron-main.
* - "electron" Alias for electron-main.
*/
target?: 'web' | 'webworker' | 'node' | 'async-node' | 'node-webkit' | 'atom' | 'electron' | 'electron-renderer' | 'electron-preload' | 'electron-main' | ((compiler?: any) => void);
/** Report the first error as a hard error instead of tolerating it. */
bail?: boolean;
/** Capture timing information for each module. */
profile?: boolean;
/** Cache generated modules and chunks to improve performance for multiple incremental builds. */
cache?: boolean | object;
/** Enter watch mode, which rebuilds on file change. */
watch?: boolean;
watchOptions?: Options.WatchOptions;
/** Include polyfills or mocks for various node stuff */
node?: Node | false;
/** Set the value of require.amd and define.amd. */
amd?: { [moduleName: string]: boolean };
/** Used for recordsInputPath and recordsOutputPath */
recordsPath?: string;
/** Load compiler state from a json file. */
recordsInputPath?: string;
/** Store compiler state to a json file. */
recordsOutputPath?: string;
/** Add additional plugins to the compiler. */
plugins?: Plugin[];
/** Stats options for logging */
stats?: Options.Stats;
/** Performance options */
performance?: Options.Performance | false;
/** Limit the number of parallel processed modules. Can be used to fine tune performance or to get more reliable profiling results */
parallelism?: number;
/** Optimization options */
optimization?: Options.Optimization;
}
interface CliConfigOptions {
config?: string;
mode?: Configuration["mode"];
env?: string;
'config-register'?: string;
configRegister?: string;
'config-name'?: string;
configName?: string;
}
type ConfigurationFactory = ((
env: string | Record<string, boolean | number | string> | undefined,
args: CliConfigOptions,
) => Configuration | Promise<Configuration>);
type MultiConfigurationFactory = ((
env: string | Record<string, boolean | number | string> | undefined,
args: CliConfigOptions,
) => Configuration[] | Promise<Configuration[]>);
interface Entry {
[name: string]: string | string[];
}
type EntryFunc = () => (string | string[] | Entry | Promise<string | string[] | Entry>);
interface DevtoolModuleFilenameTemplateInfo {
identifier: string;
shortIdentifier: string;
resource: any;
resourcePath: string;
absoluteResourcePath: string;
allLoaders: any[];
query: string;
moduleId: string;
hash: string;
}
interface Output {
/** When used in tandem with output.library and output.libraryTarget, this option allows users to insert comments within the export wrapper. */
auxiliaryComment?: string | AuxiliaryCommentObject;
/** The filename of the entry chunk as relative path inside the output.path directory. */
filename?: string | ((chunkData: ChunkData) => string);
/** The filename of non-entry chunks as relative path inside the output.path directory. */
chunkFilename?: string;
/** Number of milliseconds before chunk request expires, defaults to 120,000. */
chunkLoadTimeout?: number;
/** This option enables cross-origin loading of chunks. */
crossOriginLoading?: string | boolean;
/** The JSONP function used by webpack for asnyc loading of chunks. */
jsonpFunction?: string;
/** Allows customization of the script type webpack injects script tags into the DOM to download async chunks. */
jsonpScriptType?: 'text/javascript' | 'module';
/** Filename template string of function for the sources array in a generated SourceMap. */
devtoolModuleFilenameTemplate?: string | ((info: DevtoolModuleFilenameTemplateInfo) => string);
/** Similar to output.devtoolModuleFilenameTemplate, but used in the case of duplicate module identifiers. */
devtoolFallbackModuleFilenameTemplate?: string | ((info: DevtoolModuleFilenameTemplateInfo) => string);
/**
* Enable line to line mapped mode for all/specified modules.
* Line to line mapped mode uses a simple SourceMap where each line of the generated source is mapped to the same line of the original source.
* It’s a performance optimization. Only use it if your performance need to be better and you are sure that input lines match which generated lines.
* true enables it for all modules (not recommended)
*/
devtoolLineToLine?: boolean;
/** This option determines the modules namespace used with the output.devtoolModuleFilenameTemplate. */
devtoolNamespace?: string;
/** The filename of the Hot Update Chunks. They are inside the output.path directory. */
hotUpdateChunkFilename?: string;
/** The JSONP function used by webpack for async loading of hot update chunks. */
hotUpdateFunction?: string;
/** The filename of the Hot Update Main File. It is inside the output.path directory. */
hotUpdateMainFilename?: string;
/** If set, export the bundle as library. output.library is the name. */
library?: string | string[] | {[key: string]: string};
/**
* Which format to export the library:
* - "var" - Export by setting a variable: var Library = xxx (default)
* - "this" - Export by setting a property of this: this["Library"] = xxx
* - "commonjs" - Export by setting a property of exports: exports["Library"] = xxx
* - "commonjs2" - Export by setting module.exports: module.exports = xxx
* - "amd" - Export to AMD (optionally named)
* - "umd" - Export to AMD, CommonJS2 or as property in root
* - "window" - Assign to window
* - "assign" - Assign to a global variable
* - "jsonp" - Generate Webpack JSONP module
* - "system" - Generate a SystemJS module
*/
libraryTarget?: LibraryTarget;
/** Configure which module or modules will be exposed via the `libraryTarget` */
libraryExport?: string | string[];
/** If output.libraryTarget is set to umd and output.library is set, setting this to true will name the AMD module. */
umdNamedDefine?: boolean;
/** The output directory as absolute path. */
path?: string;
/** Include comments with information about the modules. */
pathinfo?: boolean;
/** The output.path from the view of the Javascript / HTML page. */
publicPath?: string;
/** The filename of the SourceMaps for the JavaScript files. They are inside the output.path directory. */
sourceMapFilename?: string;
/** Prefixes every line of the source in the bundle with this string. */
sourcePrefix?: string;
/** The encoding to use when generating the hash, defaults to 'hex' */
hashDigest?: 'hex' | 'latin1' | 'base64';
/** The prefix length of the hash digest to use, defaults to 20. */
hashDigestLength?: number;
/** Algorithm used for generation the hash (see node.js crypto package) */
hashFunction?: string | ((algorithm: string, options?: any) => any);
/** An optional salt to update the hash via Node.JS' hash.update. */
hashSalt?: string;
/** An expression which is used to address the global object/scope in runtime code. */
globalObject?: string;
/**
* Use the future version of asset emitting logic, which allows freeing memory of assets after emitting.
* It could break plugins which assume that assets are still readable after they were emitted.
* @deprecated - will be removed in webpack v5.0.0 and this behaviour will become the new default.
*/
futureEmitAssets?: boolean;
}
type LibraryTarget = 'var' | 'assign' | 'this' | 'window' | 'global' | 'commonjs' | 'commonjs2' | 'amd' | 'umd' | 'jsonp' | 'system';
type AuxiliaryCommentObject = { [P in LibraryTarget]: string };
interface ChunkData {
chunk: compilation.Chunk;
}
interface Module {
/** A RegExp or an array of RegExps. Don’t parse files matching. */
noParse?: RegExp | RegExp[] | ((content: string) => boolean);
unknownContextRequest?: string;
unknownContextRecursive?: boolean;
unknownContextRegExp?: RegExp;
unknownContextCritical?: boolean;
exprContextRequest?: string;
exprContextRegExp?: RegExp;
exprContextRecursive?: boolean;
exprContextCritical?: boolean;
wrappedContextRegExp?: RegExp;
wrappedContextRecursive?: boolean;
wrappedContextCritical?: boolean;
strictExportPresence?: boolean;
/** An array of rules applied for modules. */
rules: RuleSetRule[];
}
interface Resolve {
/**
* A list of directories to resolve modules from.
*
* Absolute paths will be searched once.
*
* If an entry is relative, will be resolved using node's resolution algorithm
* relative to the requested file.
*
* Defaults to `["node_modules"]`
*/
modules?: string[];
/**
* A list of package description files to search for.
*
* Defaults to `["package.json"]`
*/
descriptionFiles?: string[];
/**
* A list of fields in a package description object to use for finding
* the entry point.
*
* Defaults to `["browser", "module", "main"]` or `["module", "main"]`,
* depending on the value of the `target` `Configuration` value.
*/
mainFields?: string[] | string[][];
/**
* A list of fields in a package description object to try to parse
* in the same format as the `alias` resolve option.
*
* Defaults to `["browser"]` or `[]`, depending on the value of the
* `target` `Configuration` value.
*
* @see alias
*/
aliasFields?: string[] | string[][];
/**
* A list of file names to search for when requiring directories that
* don't contain a package description file.
*
* Defaults to `["index"]`.
*/
mainFiles?: string[];
/**
* A list of file extensions to try when requesting files.
*
* An empty string is considered invalid.
*/
extensions?: string[];
/**
* If true, requires that all requested paths must use an extension
* from `extensions`.
*/
enforceExtension?: boolean;
/**
* Replace the given module requests with other modules or paths.
*
* @see aliasFields
*/
alias?: { [key: string]: string; };
/**
* Whether to use a cache for resolving, or the specific object
* to use for caching. Sharing objects may be useful when running
* multiple webpack compilers.
*
* Defaults to `true`.
*/
unsafeCache?: {} | boolean;
/**
* A function used to decide whether to cache the given resolve request.
*
* Defaults to `() => true`.
*/
cachePredicate?(data: { path: string, request: string }): boolean;
/**
* A list of additional resolve plugins which should be applied.
*/
plugins?: ResolvePlugin[];
/**
* Whether to resolve symlinks to their symlinked location.
*
* Defaults to `true`
*/
symlinks?: boolean;
/**
* If unsafe cache is enabled, includes request.context in the cache key.
* This option is taken into account by the enhanced-resolve module.
* Since webpack 3.1.0 context in resolve caching is ignored when resolve or resolveLoader plugins are provided.
* This addresses a performance regression.
*/
cacheWithContext?: boolean;
/**
* A list of directories where requests of server-relative URLs
* (starting with '/') are resolved, defaults to context configuration option.
* On non-Windows systems these requests are resolved as an absolute path first.
*/
roots?: string[];
}
interface ResolveLoader extends Resolve {
/**
* List of strings to append to a loader's name when trying to resolve it.
*/
moduleExtensions?: string[];
enforceModuleExtension?: boolean;
}
type ExternalsElement = string | RegExp | ExternalsObjectElement | ExternalsFunctionElement;
interface ExternalsObjectElement {
[key: string]: boolean | string | string[] | Record<string, string | string[]>;
}
interface ExternalsFunctionCallback {
/**
* Invoke with no arguments to not externalize
*/
(): void;
/**
* Callback with an Error
*/
(error: {}): void; /* tslint:disable-line:unified-signatures */
/**
* Externalize the dependency
*/
(error: null, result: string | string[] | ExternalsObjectElement, type?: string): void;
}
type ExternalsFunctionElement = (context: any, request: any, callback: ExternalsFunctionCallback) => any;
interface Node {
console?: boolean | 'mock';
process?: boolean | 'mock';
global?: boolean;
__filename?: boolean | 'mock';
__dirname?: boolean | 'mock';
Buffer?: boolean | 'mock';
setImmediate?: boolean | 'mock' | 'empty';
[nodeBuiltin: string]: boolean | 'mock' | 'empty' | undefined;
}
interface NewLoader {
loader: string;
options?: { [name: string]: any };
}
type Loader = string | NewLoader;
interface ParserOptions {
[optName: string]: any;
system?: boolean;
}
type RuleSetCondition =
| RegExp
| string
| ((path: string) => boolean)
| RuleSetConditions
| {
/**
* Logical AND
*/
and?: RuleSetCondition[];
/**
* Exclude all modules matching any of these conditions
*/
exclude?: RuleSetCondition;
/**
* Exclude all modules matching not any of these conditions
*/
include?: RuleSetCondition;
/**
* Logical NOT
*/
not?: RuleSetCondition[];
/**
* Logical OR
*/
or?: RuleSetCondition[];
/**
* Exclude all modules matching any of these conditions
*/
test?: RuleSetCondition;
};
// A hack around circular type referencing
interface RuleSetConditions extends Array<RuleSetCondition> {}
interface RuleSetRule {
/**
* Enforce this rule as pre or post step
*/
enforce?: "pre" | "post";
/**
* Shortcut for resource.exclude
*/
exclude?: RuleSetCondition;
/**
* Shortcut for resource.include
*/
include?: RuleSetCondition;
/**
* Match the issuer of the module (The module pointing to this module)
*/
issuer?: RuleSetCondition;
/**
* Shortcut for use.loader
*/
loader?: RuleSetUse;
/**
* Shortcut for use.loader
*/
loaders?: RuleSetUse;
/**
* Only execute the first matching rule in this array
*/
oneOf?: RuleSetRule[];
/**
* Shortcut for use.options
*/
options?: RuleSetQuery;
/**
* Options for parsing
*/
parser?: { [k: string]: any };
/**
* Options for the resolver
*/
resolve?: Resolve;
/**
* Flags a module as with or without side effects
*/
sideEffects?: boolean;
/**
* Shortcut for use.query
*/
query?: RuleSetQuery;
/**
* Module type to use for the module
*/
type?: "javascript/auto" | "javascript/dynamic" | "javascript/esm" | "json" | "webassembly/experimental";
/**
* Match the resource path of the module
*/
resource?: RuleSetCondition;
/**
* Match the resource query of the module
*/
resourceQuery?: RuleSetCondition;
/**
* Match the child compiler name
*/
compiler?: RuleSetCondition;
/**
* Match and execute these rules when this rule is matched
*/
rules?: RuleSetRule[];
/**
* Shortcut for resource.test
*/
test?: RuleSetCondition;
/**
* Modifiers applied to the module when rule is matched
*/
use?: RuleSetUse;
}
type RuleSetUse =
| RuleSetUseItem
| RuleSetUseItem[]
| ((data: any) => RuleSetUseItem | RuleSetUseItem[]);
interface RuleSetLoader {
/**
* Loader name
*/
loader?: string;
/**
* Loader options
*/
options?: RuleSetQuery;
/**
* Unique loader identifier
*/
ident?: string;
/**
* Loader query
*/
query?: RuleSetQuery;
}
type RuleSetUseItem =
| string
| RuleSetLoader
| ((data: any) => string | RuleSetLoader);
type RuleSetQuery =
| string
| { [k: string]: any };
/**
* @deprecated Use RuleSetCondition instead
*/
type Condition = RuleSetCondition;
/**
* @deprecated Use RuleSetRule instead
*/
type Rule = RuleSetRule;
namespace Options {
type DevtoolWebpack4 = 'eval' | 'inline-source-map' | 'cheap-eval-source-map' | 'cheap-source-map' | 'cheap-module-eval-source-map' | 'cheap-module-source-map' | 'eval-source-map'
| 'source-map' | 'nosources-source-map' | 'hidden-source-map' | 'nosources-source-map' | 'inline-cheap-source-map' | 'inline-cheap-module-source-map' | '@eval'
| '@inline-source-map' | '@cheap-eval-source-map' | '@cheap-source-map' | '@cheap-module-eval-source-map' | '@cheap-module-source-map' | '@eval-source-map'
| '@source-map' | '@nosources-source-map' | '@hidden-source-map' | '@nosources-source-map' | '#eval' | '#inline-source-map' | '#cheap-eval-source-map'
| '#cheap-source-map' | '#cheap-module-eval-source-map' | '#cheap-module-source-map' | '#eval-source-map' | '#source-map' | '#nosources-source-map'
| '#hidden-source-map' | '#nosources-source-map' | '#@eval' | '#@inline-source-map' | '#@cheap-eval-source-map' | '#@cheap-source-map' | '#@cheap-module-eval-source-map'
| '#@cheap-module-source-map' | '#@eval-source-map' | '#@source-map' | '#@nosources-source-map' | '#@hidden-source-map' | '#@nosources-source-map' | boolean;
type DevtoolWebpack5 = 'eval-cheap-source-map' | 'eval-cheap-module-source-map' | 'eval-nosources-cheap-source-map' | 'eval-nosources-cheap-module-source-map' | 'eval-nosources-source-map'
| 'inline-nosources-cheap-source-map' | 'inline-nosources-cheap-module-source-map' | 'inline-nosources-source-map' | 'nosources-cheap-source-map' | 'nosources-cheap-module-source-map'
| 'hidden-nosources-cheap-source-map' | 'hidden-nosources-cheap-module-source-map' | 'hidden-nosources-source-map' | 'hidden-cheap-source-map' | 'hidden-cheap-module-source-map';
type Devtool = DevtoolWebpack4 | DevtoolWebpack5;
interface Performance {
/** This property allows webpack to control what files are used to calculate performance hints. */
assetFilter?(assetFilename: string): boolean;
/**
* Turns hints on/off. In addition, tells webpack to throw either an error or a warning when hints are
* found. This property is set to "warning" by default.
*/
hints?: 'warning' | 'error' | false;
/**
* An asset is any emitted file from webpack. This option controls when webpack emits a performance hint
* based on individual asset size. The default value is 250000 (bytes).
*/
maxAssetSize?: number;
/**
* An entrypoint represents all assets that would be utilized during initial load time for a specific entry.
* This option controls when webpack should emit performance hints based on the maximum entrypoint size.
* The default value is 250000 (bytes).
*/
maxEntrypointSize?: number;
}
type Stats = Stats.ToStringOptions;
type WatchOptions = ICompiler.WatchOptions;
interface CacheGroupsOptions {
/** Assign modules to a cache group */
test?: ((...args: any[]) => boolean) | string | RegExp;
/** Select chunks for determining cache group content (defaults to \"initial\", \"initial\" and \"all\" requires adding these chunks to the HTML) */
chunks?: "initial" | "async" | "all" | ((chunk: compilation.Chunk) => boolean);
/** Ignore minimum size, minimum chunks and maximum requests and always create chunks for this cache group */
enforce?: boolean;
/** Priority of this cache group */
priority?: number;
/** Minimal size for the created chunk */
minSize?: number;
/** Maximum size for the created chunk */
maxSize?: number;
/** Minimum number of times a module has to be duplicated until it's considered for splitting */
minChunks?: number;
/** Maximum number of requests which are accepted for on-demand loading */
maxAsyncRequests?: number;
/** Maximum number of initial chunks which are accepted for an entry point */
maxInitialRequests?: number;
/** Try to reuse existing chunk (with name) when it has matching modules */
reuseExistingChunk?: boolean;
/** Give chunks created a name (chunks with equal name are merged) */
name?: boolean | string | ((...args: any[]) => any);
}
interface SplitChunksOptions {
/** Select chunks for determining shared modules (defaults to \"async\", \"initial\" and \"all\" requires adding these chunks to the HTML) */
chunks?: "initial" | "async" | "all" | ((chunk: compilation.Chunk) => boolean);
/** Minimal size for the created chunk */
minSize?: number;
/** Maximum size for the created chunk */
maxSize?: number;
/** Minimum number of times a module has to be duplicated until it's considered for splitting */
minChunks?: number;
/** Maximum number of requests which are accepted for on-demand loading */
maxAsyncRequests?: number;
/** Maximum number of initial chunks which are accepted for an entry point */
maxInitialRequests?: number;
/** Give chunks created a name (chunks with equal name are merged) */
name?: boolean | string | ((...args: any[]) => any);
/** Assign modules to a cache group (modules from different cache groups are tried to keep in separate chunks) */
cacheGroups?: false | string | ((...args: any[]) => any) | RegExp | { [key: string]: CacheGroupsOptions | false };
/** Override the default name separator (~) when generating names automatically (name: true) */
automaticNameDelimiter?: string;
}
interface RuntimeChunkOptions {
/** The name or name factory for the runtime chunks. */
name?: string | ((...args: any[]) => any);
}
interface Optimization {
/**
* Modules are removed from chunks when they are already available in all parent chunk groups.
* This reduces asset size. Smaller assets also result in faster builds since less code generation has to be performed.
*/
removeAvailableModules?: boolean;
/** Empty chunks are removed. This reduces load in filesystem and results in faster builds. */
removeEmptyChunks?: boolean;
/** Equal chunks are merged. This results in less code generation and faster builds. */
mergeDuplicateChunks?: boolean;
/** Chunks which are subsets of other chunks are determined and flagged in a way that subsets don’t have to be loaded when the bigger chunk has been loaded. */
flagIncludedChunks?: boolean;
/** Give more often used ids smaller (shorter) values. */
occurrenceOrder?: boolean;
/** Determine exports for each module when possible. This information is used by other optimizations or code generation. I. e. to generate more efficient code for export * from. */
providedExports?: boolean;
/**
* Determine used exports for each module. This depends on optimization.providedExports. This information is used by other optimizations or code generation.
* I. e. exports are not generated for unused exports, export names are mangled to single char identifiers when all usages are compatible.
* DCE in minimizers will benefit from this and can remove unused exports.
*/
usedExports?: boolean;
/**
* Recognise the sideEffects flag in package.json or rules to eliminate modules. This depends on optimization.providedExports and optimization.usedExports.
* These dependencies have a cost, but eliminating modules has positive impact on performance because of less code generation. It depends on your codebase.
* Try it for possible performance wins.
*/
sideEffects?: boolean;
/** Tries to find segments of the module graph which can be safely concatenated into a single module. Depends on optimization.providedExports and optimization.usedExports. */
concatenateModules?: boolean;
/** Finds modules which are shared between chunk and splits them into separate chunks to reduce duplication or separate vendor modules from application modules. */
splitChunks?: SplitChunksOptions | false;
/** Create a separate chunk for the webpack runtime code and chunk hash maps. This chunk should be inlined into the HTML */
runtimeChunk?: boolean | "single" | "multiple" | RuntimeChunkOptions;
/** Avoid emitting assets when errors occur. */
noEmitOnErrors?: boolean;
/** Instead of numeric ids, give modules readable names for better debugging. */
namedModules?: boolean;
/** Instead of numeric ids, give chunks readable names for better debugging. */
namedChunks?: boolean;
/** Tells webpack which algorithm to use when choosing module ids. Default false. */
moduleIds?: boolean | "natural" | "named" | "hashed" | "size" | "total-size";
/** Tells webpack which algorithm to use when choosing chunk ids. Default false. */
chunkIds?: boolean | "natural" | "named" | "size" | "total-size";
/** Defines the process.env.NODE_ENV constant to a compile-time-constant value. This allows to remove development only code from code. */
nodeEnv?: string | false;
/** Use the minimizer (optimization.minimizer, by default uglify-js) to minimize output assets. */
minimize?: boolean;
/** Minimizer(s) to use for minimizing the output */
minimizer?: Array<Plugin | Tapable.Plugin>;
/** Generate records with relative paths to be able to move the context folder". */
portableRecords?: boolean;
}
}
/**
* @see https://webpack.js.org/api/logging/
* @since 4.39.0
*/
interface Logger {
error(message?: any, ...optionalParams: any[]): void;
warn(message?: any, ...optionalParams: any[]): void;
info(message?: any, ...optionalParams: any[]): void;
log(message?: any, ...optionalParams: any[]): void;
debug(message?: any, ...optionalParams: any[]): void;
trace(message?: any, ...optionalParams: any[]): void;
group(...label: any[]): void;
groupEnd(): void;
groupCollapsed(...label: any[]): void;
status(message?: any, ...optionalParams: any[]): void;
clear(): void;
profile(label?: string): void;
profileEnd(label?: string): void;
}
namespace debug {
interface ProfilingPluginOptions {
/** A relative path to a custom output file (json) */
outputPath?: string;
}
/**
* Generate Chrome profile file which includes timings of plugins execution. Outputs `events.json` file by
* default. It is possible to provide custom file path using `outputPath` option.
*
* In order to view the profile file:
* * Run webpack with ProfilingPlugin.
* * Go to Chrome, open the Profile Tab.
* * Drag and drop generated file (events.json by default) into the profiler.
*
* It will then display timeline stats and calls per plugin!
*/
class ProfilingPlugin extends Plugin {
constructor(options?: ProfilingPluginOptions);
}
}
type LibraryExport = string | string[];
interface AssetInfo {
/**
* true, if the asset can be long term cached forever (contains a hash)
*/
immutable?: boolean;
/**
* the value(s) of the full hash used for this asset
*/
fullhash?: LibraryExport;
/**
* the value(s) of the chunk hash used for this asset
*/
chunkhash?: LibraryExport;
/**
* the value(s) of the module hash used for this asset
*/
modulehash?: LibraryExport;
/**
* the value(s) of the content hash used for this asset
*/
contenthash?: LibraryExport;
/**
* size in bytes, only set after asset has been emitted
*/
size?: number;
/**
* true, when asset is only used for development and doesn't count towards user-facing assets
*/
development?: boolean;
/**
* true, when asset ships data for updating an existing application (HMR)
*/
hotModuleReplacement?: boolean;
/**
* object of pointers to other assets, keyed by type of relation (only points from parent to child)
*/
related?: Record<string, LibraryExport>;
}
namespace compilation {
class Asset {
/**
* the filename of the asset
*/
name: string;
/**
* source of the asset
*/
source: Source;
/**
* info about the asset
*/
info: AssetInfo;
}
class DependenciesBlock {
}
class Module extends DependenciesBlock {
constructor(type: string, context?: string);
type: string;
context: string | null;
debugId: number;
hash: string | undefined;
renderedHash: string | undefined;
resolveOptions: any;
factoryMeta: any;
warnings: any[];
errors: any[];
buildMeta: any;
buildInfo: any;
reasons: any[];
_chunks: SortableSet<Chunk>;
id: number | string | null;
index: number | null;
index2: number | null;
depth: number | null;
issuer: Module | null;
profile: any;
prefetched: boolean;
built: boolean;
used: null | boolean;
usedExports: false | true | string[] | null;
optimizationBailout: string | any[];
_rewriteChunkInReasons: {
oldChunk: Chunk, newChunks: Chunk[]
} | undefined;
useSourceMap: boolean;
_source: any;
exportsArgument: string | 'exports';
moduleArgument: string | 'module';
disconnect(): void;
unseal(): void;
setChunks(chunks: Chunk[]): void;
addChunk(chunk: Chunk): boolean;
removeChunk(chunk: Chunk): boolean;
isInChunk(chunk: Chunk): boolean;
isEntryModule(): boolean;
optional: boolean;
getChunks(): Chunk[];
getNumberOfChunks: number;
chunksIterable: SortableSet<Chunk>;
hasEqualsChunks(module: Module): boolean;
addReason(module: Module, dependency: any, explanation: any): void;
removeReason(module: Module, dependency: any): boolean;
hasReasonForChunk(chunk: Chunk): boolean;
hasReasons(): boolean;
rewriteChunkInReasons(oldChunk: Chunk, newChunks: Chunk[]): void;
_doRewriteChunkInReasons(oldChunk: Chunk, newChunks: Chunk[]): void;
isUsed(exportName?: string): boolean | string;
isProvided(exportName: string): boolean | null;
toString(): string;
needRebuild(fileTimestamps: any, contextTimestamps: any): boolean;
updateHash(hash: any): void;
sortItems(sortChunks?: boolean): void;
unbuild(): void;
}
class Record {
}
class Chunk {
constructor(name?: string);
id: number | null;
ids: number[] | null;
debugId: number;
name: string;
preventIntegration: boolean;
entryModule: Module | undefined;
_modules: SortableSet<Module>;
filenameTemplate: string | undefined;
_groups: SortableSet<ChunkGroup>;
files: string[];
rendered: boolean;
hash: string | undefined;
contentHash: object;
renderedHash: string | undefined;
chunkReason: string | undefined;
extraAsync: boolean;
removedModules: any;
hasRuntime(): boolean;
canBeInitial(): boolean;
isOnlyInitial(): boolean;
hasEntryModule(): boolean;
addModule(module: Module): boolean;
removeModule(module: Module): boolean;
setModules(modules: Module[]): void;
getNumberOfModules(): number;
// Internally returns this._modules
// So it should have the same type as this._modules
modulesIterable: SortableSet<Module>;
addGroup(chunkGroup: ChunkGroup): boolean;
removeGroup(chunkGroup: ChunkGroup): boolean;
isInGroup(chunkGroup: ChunkGroup): boolean;
getNumberOfGroups(): number;
// Internally returns this._groups
// So it should have the same type as this._groups
groupsIterable: SortableSet<ChunkGroup>;
compareTo(otherChunk: Chunk): -1 | 0 | 1;
containsModule(module: Module): boolean;
getModules(): Module[];
getModulesIdent(): any[];
remove(reason?: string): void;
moveModule(module: Module, otherChunk: Chunk): void;
integrate(otherChunk: Chunk, reason: string): boolean;
split(newChunk: Chunk): void;
isEmpty(): boolean;
updateHash(hash: any): void;
canBeIntegrated(otherChunk: Chunk): boolean;
addMultiplierAndOverhead(
size: number,
options: {
chunkOverhead?: number;
entryChunkMultiplicator?: number
},
): number;
modulesSize(): number;
size(options?: {
chunkOverhead?: number;
entryChunkMultiplicator?: number
}): number;
integratedSize(otherChunk: Chunk, options: any): number | false;
sortModules(
sortByFn: (module1: Module, module2: Module) => -1 | 0 | 1
): void;
sortItems(): void;
getAllAsyncChunks(): Set<Chunk>;
getChunkMaps(realHash: boolean): {
hash: any;
contentHash: any;
name: any;
};
getChildIdsByOrders(): any;
getChildIdsByOrdersMap(includeDirectChildren?: boolean): any;
// tslint:disable-next-line:ban-types
getChunkModuleMaps(filterFn: Function): { id: any; hash: any };
hasModuleInGraph(
filterFn: (module: Module) => boolean,
filterChunkFn: (chunk: Chunk) => boolean
): boolean;
toString(): string;
}
type GroupOptions = string | { name?: string; };
class ChunkGroup {
chunks: Chunk[];
childrenIterable: SortableSet<ChunkGroup>;
parentsIterable: SortableSet<ChunkGroup>;
insertChunk(chunk: Chunk, before: Chunk): boolean;
getNumberOfChildren(): number;
setModuleIndex(module: Module, index: number): void;
getModuleIndex(module: Module): number | undefined;
setModuleIndex2(module: Module, index: number): void;
getModuleIndex2(module: Module): number | undefined;
addChild(chunk: ChunkGroup): boolean;
removeChild(chunk: ChunkGroup): boolean;
setParents(newParents: Iterable<ChunkGroup>): void;
}
class ChunkHash {
update(data: string | Buffer, inputEncoding?: string): ChunkHash;
}
interface SourcePosition {
line: number;
column?: number;
}
interface RealDependencyLocation {
start: SourcePosition;
end?: SourcePosition;
index?: number;
}
interface SynteticDependencyLocation {
name: string;
index?: number;
}
type DependencyLocation = SynteticDependencyLocation | RealDependencyLocation;
class Dependency {
constructor();
getResourceIdentifier(): any;
getReference(): any;
getExports(): any;
getWarnings(): any;
getErrors(): any;
updateHash(hash: any): void;
disconnect(): void;
static compare(a: any, b: any): any;
}
interface NormalModuleFactoryHooks {
resolver: SyncWaterfallHook;
factory: SyncWaterfallHook;
beforeResolve: AsyncSeriesWaterfallHook;
afterResolve: AsyncSeriesWaterfallHook;
createModule: SyncBailHook;
module: SyncWaterfallHook;
createParser: HookMap;
parser: HookMap<normalModuleFactory.Parser>;
createGenerator: HookMap;
generator: HookMap;
}
class NormalModuleFactory extends Tapable {
hooks: NormalModuleFactoryHooks;
}
namespace normalModuleFactory {
interface ParserHooks {
evaluateTypeof: HookMap;
evaluate: HookMap;
evaluateIdentifier: HookMap;
evaluateDefinedIdentifier: HookMap;
evaluateCallExpressionMember: HookMap;
statement: SyncBailHook;
statementIf: SyncBailHook;
label: HookMap;
import: SyncBailHook;
importSpecifier: SyncBailHook;
export: SyncBailHook;
exportImport: SyncBailHook;
exportDeclaration: SyncBailHook;
exportExpression: SyncBailHook;
exportSpecifier: SyncBailHook;
exportImportSpecifier: SyncBailHook;
varDeclaration: SyncBailHook;
varDeclarationLet: HookMap;
varDeclarationConst: HookMap;
varDeclarationVar: HookMap;
canRename: HookMap;
rename: HookMap;
assigned: HookMap;
typeof: HookMap;
importCall: SyncBailHook;
call: HookMap;
callAnyMember: HookMap;
new: HookMap;
expression: HookMap;
expressionAnyMember: HookMap;
expressionConditionalOperator: SyncBailHook;
expressionLogicalOperator: SyncBailHook;
program: SyncBailHook;
}
class Parser extends Tapable {
hooks: ParserHooks;
}
}
interface ContextModuleFactoryHooks {
beforeResolve: AsyncSeriesWaterfallHook;
afterResolve: AsyncSeriesWaterfallHook;
contextModuleFiles: SyncWaterfallHook;
alternatives: AsyncSeriesWaterfallHook;
}
class ContextModuleFactory extends Tapable {
hooks: ContextModuleFactoryHooks;
}
class DllModuleFactory extends Tapable {
hooks: {};
}
interface CompilationHooks {
buildModule: SyncHook<Module>;
rebuildModule: SyncHook<Module>;
failedModule: SyncHook<Module, Error>;
succeedModule: SyncHook<Module>;
finishModules: SyncHook<Module[]>;
finishRebuildingModule: SyncHook<Module>;
unseal: SyncHook;
seal: SyncHook;
optimizeDependenciesBasic: SyncBailHook<Module[]>;
optimizeDependencies: SyncBailHook<Module[]>;
optimizeDependenciesAdvanced: SyncBailHook<Module[]>;
afterOptimizeDependencies: SyncHook<Module[]>;
optimize: SyncHook;
optimizeModulesBasic: SyncBailHook<Module[]>;
optimizeModules: SyncBailHook<Module[]>;
optimizeModulesAdvanced: SyncBailHook<Module[]>;
afterOptimizeModules: SyncHook<Module[]>;
optimizeChunksBasic: SyncBailHook<Chunk[], ChunkGroup[]>;
optimizeChunks: SyncBailHook<Chunk[], ChunkGroup[]>;
optimizeChunksAdvanced: SyncBailHook<Chunk[], ChunkGroup[]>;
afterOptimizeChunks: SyncHook<Chunk[], ChunkGroup[]>;
optimizeTree: AsyncSeriesHook<Chunk[], Module[]>;
afterOptimizeTree: SyncHook<Chunk[], Module[]>;
optimizeChunkModulesBasic: SyncBailHook<Chunk[], Module[]>;
optimizeChunkModules: SyncBailHook<Chunk[], Module[]>;
optimizeChunkModulesAdvanced: SyncBailHook<Chunk[], Module[]>;
afterOptimizeChunkModules: SyncHook<Chunk[], Module[]>;
shouldRecord: SyncBailHook;
reviveModules: SyncHook<Module[], Record[]>;
optimizeModuleOrder: SyncHook<Module[]>;
advancedOptimizeModuleOrder: SyncHook<Module[]>;
beforeModuleIds: SyncHook<Module[]>;
moduleIds: SyncHook<Module[]>;
optimizeModuleIds: SyncHook<Module[]>;
afterOptimizeModuleIds: SyncHook<Module[]>;
reviveChunks: SyncHook<Chunk[], Record[]>;
optimizeChunkOrder: SyncHook<Chunk[]>;
beforeChunkIds: SyncHook<Chunk[]>;
optimizeChunkIds: SyncHook<Chunk[]>;
afterOptimizeChunkIds: SyncHook<Chunk[]>;
recordModules: SyncHook<Module[], Record[]>;
recordChunks: SyncHook<Chunk[], Record[]>;
beforeHash: SyncHook;
afterHash: SyncHook;
recordHash: SyncHook<Record[]>;
record: SyncHook<Compilation, Record[]>;
beforeModuleAssets: SyncHook;
shouldGenerateChunkAssets: SyncBailHook;
beforeChunkAssets: SyncHook;
additionalChunkAssets: SyncHook<Chunk[]>;
records: SyncHook<Compilation, Record[]>;
additionalAssets: AsyncSeriesHook;
optimizeChunkAssets: AsyncSeriesHook<Chunk[]>;
afterOptimizeChunkAssets: SyncHook<Chunk[]>;
optimizeAssets: AsyncSeriesHook<Asset[]>;
afterOptimizeAssets: SyncHook<Asset[]>;
needAdditionalSeal: SyncBailHook;
afterSeal: AsyncSeriesHook;
chunkHash: SyncHook<Chunk, ChunkHash>;
moduleAsset: SyncHook<Module, string>;
chunkAsset: SyncHook<Chunk, string>;
assetPath: SyncWaterfallHook<string>;
needAdditionalPass: SyncBailHook;
childCompiler: SyncHook;
normalModuleLoader: SyncHook<any, Module>;
optimizeExtractedChunksBasic: SyncBailHook<Chunk[]>;
optimizeExtractedChunks: SyncBailHook<Chunk[]>;
optimizeExtractedChunksAdvanced: SyncBailHook<Chunk[]>;
afterOptimizeExtractedChunks: SyncHook<Chunk[]>;
}
interface CompilationModule {
module: any;
issuer: boolean;
build: boolean;
dependencies: boolean;
}
class MainTemplate extends Tapable {
hooks: {
jsonpScript?: SyncWaterfallHook<string, Chunk, string>;
require: SyncWaterfallHook<string, Chunk, string>;
requireExtensions: SyncWaterfallHook<string, Chunk, string>;
requireEnsure: SyncWaterfallHook<string, Chunk, string>;
localVars: SyncWaterfallHook<string, Chunk, string>;
afterStartup: SyncWaterfallHook<string, Chunk, string>;
hash: SyncHook<CryptoHash>;
hashForChunk: SyncHook<CryptoHash, Chunk>;
};
outputOptions: Output;
requireFn: string;
renderRequireFunctionForModule(hash: string, chunk: Chunk, varModuleId?: number | string): string;
renderAddModule(hash: string, chunk: Chunk, varModuleId: number | string | undefined, varModule: string): string;
}
class ChunkTemplate extends Tapable {}
class HotUpdateChunkTemplate extends Tapable {}
class RuntimeTemplate {}
interface ModuleTemplateHooks {
content: SyncWaterfallHook;
module: SyncWaterfallHook;
render: SyncWaterfallHook;
package: SyncWaterfallHook;
hash: SyncHook;
}
class ModuleTemplate extends Tapable {
hooks: ModuleTemplateHooks;
}
class Compilation extends Tapable {
hooks: CompilationHooks;
compiler: Compiler;
resolverFactory: any;
inputFileSystem: any;
requestShortener: any;
outputOptions: any;
bail: any;
profile: any;
performance: any;
mainTemplate: MainTemplate;
chunkTemplate: ChunkTemplate;
hotUpdateChunkTemplate: HotUpdateChunkTemplate;
runtimeTemplate: RuntimeTemplate;
moduleTemplates: {
javascript: ModuleTemplate;
webassembly: ModuleTemplate;
};
isChild(): boolean;
context: string;
outputPath: string;
entries: any[];
_preparedEntrypoints: any[];
entrypoints: Map<any, any>;
chunks: any[];
chunkGroups: any[];
namedChunkGroups: Map<any, any>;
namedChunks: Map<any, any>;
modules: any[];
_modules: Map<any, any>;
cache: any;
records: any;
nextFreeModuleIndex: any;
nextFreeModuleIndex2: any;
additionalChunkAssets: any[];
assets: any;
errors: any[];
warnings: any[];
children: any[];
dependencyFactories: Map<typeof Dependency, Tapable>;
dependencyTemplates: Map<typeof Dependency, Tapable>;
childrenCounters: any;
usedChunkIds: any;
usedModuleIds: any;
fileTimestamps: Map<string, number>;
contextTimestamps: Map<string, number>;
fileDependencies: SortableSet<string>;
contextDependencies: SortableSet<string>;
missingDependencies: SortableSet<string>;
hash?: string;
getStats(): Stats;
addChunkInGroup(groupOptions: GroupOptions): ChunkGroup;
addChunkInGroup(groupOptions: GroupOptions, module: Module, loc: DependencyLocation, request: string): ChunkGroup;
addModule(module: CompilationModule, cacheGroup: any): any;
// tslint:disable-next-line:ban-types
addEntry(context: any, entry: any, name: any, callback: Function): void;
getPath(filename: string, data: {
hash?: any,
chunk?: any,
filename?: string,
basename?: string,
query?: any,
contentHashType?: string,
contentHash?: string,
}): string;
getAsset(name: string): Readonly<Asset>;
updateAsset(
file: string,
newSourceOrFunction: Source | ((arg0: Source) => Source),
assetInfoUpdateOrFunction?: AssetInfo | ((arg0: AssetInfo) => AssetInfo)
): void;
/**
* @deprecated Compilation.applyPlugins is deprecated. Use new API on `.hooks` instead
*/
applyPlugins(name: string, ...args: any[]): void;
getLogger(pluginName: string): Logger;
}
interface CompilerHooks {
shouldEmit: SyncBailHook<Compilation>;
done: AsyncSeriesHook<Stats>;
additionalPass: AsyncSeriesHook;
beforeRun: AsyncSeriesHook<Compiler>;
run: AsyncSeriesHook<Compiler>;
emit: AsyncSeriesHook<Compilation>;
afterEmit: AsyncSeriesHook<Compilation>;
thisCompilation: SyncHook<Compilation, { normalModuleFactory: NormalModuleFactory }>;
compilation: SyncHook<Compilation, { normalModuleFactory: NormalModuleFactory }>;
normalModuleFactory: SyncHook<NormalModuleFactory>;
contextModuleFactory: SyncHook<ContextModuleFactory>;
beforeCompile: AsyncSeriesHook<{}>;
compile: SyncHook<{}>;
make: AsyncParallelHook<Compilation>;
afterCompile: AsyncSeriesHook<Compilation>;
watchRun: AsyncSeriesHook<Compiler>;
failed: SyncHook<Error>;
invalid: SyncHook<string, Date>;
watchClose: SyncHook;
environment: SyncHook;
afterEnvironment: SyncHook;
afterPlugins: SyncHook<Compiler>;
afterResolvers: SyncHook<Compiler>;
entryOption: SyncBailHook;
}
interface MultiStats {
stats: Stats[];
hash: string;
/** Returns true if there were errors while compiling. */
hasErrors(): boolean;
/** Returns true if there were warnings while compiling. */
hasWarnings(): boolean;
/** Returns compilation information as a JSON object. */
toJson(options?: Stats.ToJsonOptions): Stats.ToJsonOutput;
/** Returns a formatted string of the compilation information (similar to CLI output). */
toString(options?: Stats.ToStringOptions): string;
}
interface MultiCompilerHooks {
done: SyncHook<MultiStats>;
invalid: SyncHook<string, Date>;
run: AsyncSeriesHook<Compiler>;
watchClose: SyncHook;
watchRun: AsyncSeriesHook<Compiler>;
}
}
// tslint:disable-next-line:interface-name
interface ICompiler {
run(handler: ICompiler.Handler | ICompiler.MultiHandler): void;
watch(watchOptions: ICompiler.WatchOptions, handler: ICompiler.Handler | ICompiler.MultiHandler): Watching;
}
namespace ICompiler {
import MultiStats = compilation.MultiStats;
type Handler = (err: Error, stats: Stats) => void;
type MultiHandler = (err: Error, stats: MultiStats) => void;
interface WatchOptions {
/**
* Add a delay before rebuilding once the first file changed. This allows webpack to aggregate any other
* changes made during this time period into one rebuild.
* Pass a value in milliseconds. Default: 300.
*/
aggregateTimeout?: number;
/**
* For some systems, watching many file systems can result in a lot of CPU or memory usage.
* It is possible to exclude a huge folder like node_modules.
* It is also possible to use anymatch patterns.
*/
ignored?: anymatch.Matcher;
/** Turn on polling by passing true, or specifying a poll interval in milliseconds. */
poll?: boolean | number;
}
}
interface Watching {
close(callback: () => void): void;
invalidate(): void;
}
interface InputFileSystem {
purge?(): void;
readFile(path: string, callback: (err: Error | undefined | null, contents: Buffer) => void): void;
readFileSync(path: string): Buffer;
readlink(path: string, callback: (err: Error | undefined | null, linkString: string) => void): void;
readlinkSync(path: string): string;
stat(path: string, callback: (err: Error | undefined | null, stats: any) => void): void;
statSync(path: string): any;
}
interface OutputFileSystem {
join(...paths: string[]): string;
mkdir(path: string, callback: (err: Error | undefined | null) => void): void;
mkdirp(path: string, callback: (err: Error | undefined | null) => void): void;
rmdir(path: string, callback: (err: Error | undefined | null) => void): void;
unlink(path: string, callback: (err: Error | undefined | null) => void): void;
writeFile(path: string, data: any, callback: (err: Error | undefined | null) => void): void;
}
interface SortableSet<T> extends Set<T> {
sortWith(sortFn: (a: T, b: T) => number): void;
sort(): void;
getFromCache(fn: (set: SortableSet<T>) => T[]): T[];
getFromUnorderedCache(fn: (set: SortableSet<T>) => string|number|T[]): any;
}
class Compiler extends Tapable implements ICompiler {
constructor();
hooks: compilation.CompilerHooks;
_pluginCompat: SyncBailHook<compilation.Compilation>;
name: string;
isChild(): boolean;
context: string;
outputPath: string;
options: Configuration;
inputFileSystem: InputFileSystem;
outputFileSystem: OutputFileSystem;
fileTimestamps: Map<string, number>;
contextTimestamps: Map<string, number>;
run(handler: Compiler.Handler): void;
watch(watchOptions: Compiler.WatchOptions, handler: Compiler.Handler): Compiler.Watching;
getInfrastructureLogger(name: string): Logger;
}
namespace Compiler {
type Handler = ICompiler.Handler;
type WatchOptions = ICompiler.WatchOptions;
class Watching implements Watching {
constructor(compiler: Compiler, watchOptions: Watching.WatchOptions, handler: Watching.Handler);
close(callback: () => void): void;
invalidate(): void;
}
namespace Watching {
type WatchOptions = ICompiler.WatchOptions;
type Handler = ICompiler.Handler;
}
}
abstract class MultiCompiler extends Tapable implements ICompiler {
compilers: Compiler[];
hooks: compilation.MultiCompilerHooks;
run(handler: MultiCompiler.Handler): void;
watch(watchOptions: MultiCompiler.WatchOptions, handler: MultiCompiler.Handler): MultiWatching;
}
namespace MultiCompiler {
type Handler = ICompiler.MultiHandler;
type WatchOptions = ICompiler.WatchOptions;
}
abstract class MultiWatching implements Watching {
close(callback: () => void): void;
invalidate(): void;
}
abstract class Plugin implements Tapable.Plugin {
apply(compiler: Compiler): void;
}
// Compatibility with webpack@5's own types
// See https://github.com/webpack/webpack/issues/11630
// tslint:disable-next-line no-empty-interface
interface WebpackPluginInstance extends Plugin {}
// tslint:disable-next-line no-empty-interface
interface Chunk extends compilation.Chunk {}
abstract class ResolvePlugin implements Tapable.Plugin {
apply(resolver: any /* EnhancedResolve.Resolver */): void;
}
class Stats {
compilation: compilation.Compilation;
hash?: string;
startTime?: number;
endTime?: number;
static filterWarnings(
warnings: string[],
warningsFilter?: Array<string | RegExp | ((warning: string) => boolean)>
): string[];
/**
* Returns the default json options from the stats preset.
* @param preset The preset to be transformed into json options.
*/
static presetToOptions(preset?: Stats.Preset): Stats.ToJsonOptionsObject;
constructor(compilation: compilation.Compilation);
formatFilePath(filePath: string): string;
/** Returns true if there were errors while compiling. */
hasErrors(): boolean;
/** Returns true if there were warnings while compiling. */
hasWarnings(): boolean;
/** Remove a prefixed "!" that can be specified to reverse sort order */
normalizeFieldKey(field: string): string;
/** if a field is prefixed by a "!" reverse sort order */
sortOrderRegular(field: string): boolean;
/** Returns compilation information as a JSON object. */
toJson(options?: Stats.ToJsonOptions, forToString?: boolean): Stats.ToJsonOutput;
/** Returns a formatted string of the compilation information (similar to CLI output). */
toString(options?: Stats.ToStringOptions): string;
}
namespace Stats {
type Preset
= boolean
| 'errors-only'
| 'errors-warnings'
| 'minimal'
| 'none'
| 'normal'
| 'verbose';
interface ToJsonOptionsObject {
/** fallback value for stats options when an option is not defined (has precedence over local webpack defaults) */
all?: boolean;
/** Add asset Information */
assets?: boolean;
/** Sort assets by a field */
assetsSort?: string;
/** Add built at time information */
builtAt?: boolean;
/** Add information about cached (not built) modules */
cached?: boolean;
/** Show cached assets (setting this to `false` only shows emitted files) */
cachedAssets?: boolean;
/** Add children information */
children?: boolean;
/** Add information about the `namedChunkGroups` */
chunkGroups?: boolean;
/** Add built modules information to chunk information */
chunkModules?: boolean;
/** Add the origins of chunks and chunk merging info */
chunkOrigins?: boolean;
/** Add chunk information (setting this to `false` allows for a less verbose output) */
chunks?: boolean;
/** Sort the chunks by a field */
chunksSort?: string;
/** Context directory for request shortening */
context?: string;
/** Display the distance from the entry point for each module */
depth?: boolean;
/** Display the entry points with the corresponding bundles */
entrypoints?: boolean;
/** Add --env information */
env?: boolean;
/** Add errors */
errors?: boolean;
/** Add details to errors (like resolving log) */
errorDetails?: boolean;
/** Exclude assets from being displayed in stats */
excludeAssets?: StatsExcludeFilter;
/** Exclude modules from being displayed in stats */
excludeModules?: StatsExcludeFilter;
/** See excludeModules */
exclude?: StatsExcludeFilter;
/** Add the hash of the compilation */
hash?: boolean;
/** Set the maximum number of modules to be shown */
maxModules?: number;
/** Add built modules information */
modules?: boolean;
/** Sort the modules by a field */
modulesSort?: string;
/** Show dependencies and origin of warnings/errors */
moduleTrace?: boolean;
/** Add public path information */
publicPath?: boolean;
/** Add information about the reasons why modules are included */
reasons?: boolean;
/** Add the source code of modules */
source?: boolean;
/** Add timing information */
timings?: boolean;
/** Add webpack version information */
version?: boolean;
/** Add warnings */
warnings?: boolean;
/** Show which exports of a module are used */
usedExports?: boolean;
/** Filter warnings to be shown */
warningsFilter?: string | RegExp | Array<string | RegExp> | ((warning: string) => boolean);
/** Show performance hint when file size exceeds `performance.maxAssetSize` */
performance?: boolean;
/** Show the exports of the modules */
providedExports?: boolean;
}
type ToJsonOptions = Preset | ToJsonOptionsObject;
interface ChunkGroup {
assets: string[];
chunks: Array<number | string>;
children: Record<string, {
assets: string[];
chunks: Array<number | string>;
name: string;
}>;
childAssets: Record<string, string[]>;
isOverSizeLimit?: boolean;
}
type ReasonType
= 'amd define'
| 'amd require array'
| 'amd require context'
| 'amd require'
| 'cjs require context'
| 'cjs require'
| 'context element'
| 'delegated exports'
| 'delegated source'
| 'dll entry'
| 'accepted harmony modules'
| 'harmony accept'
| 'harmony export expression'
| 'harmony export header'
| 'harmony export imported specifier'
| 'harmony export specifier'
| 'harmony import specifier'
| 'harmony side effect evaluation'
| 'harmony init'
| 'import() context development'
| 'import() context production'
| 'import() eager'
| 'import() weak'
| 'import()'
| 'json exports'
| 'loader'
| 'module.hot.accept'
| 'module.hot.decline'
| 'multi entry'
| 'null'
| 'prefetch'
| 'require.context'
| 'require.ensure'
| 'require.ensure item'
| 'require.include'
| 'require.resolve'
| 'single entry'
| 'wasm export import'
| 'wasm import';
interface Reason {
moduleId: number | string | null;
moduleIdentifier: string | null;
module: string | null;
moduleName: string | null;
type: ReasonType;
explanation?: string;
userRequest: string;
loc: string;
}
interface FnModules {
assets?: string[];
built: boolean;
cacheable: boolean;
chunks: Array<number | string>;
depth?: number;
errors: number;
failed: boolean;
filteredModules?: boolean;
id: number | string;
identifier: string;
index: number;
index2: number;
issuer: string | undefined;
issuerId: number | string | undefined;
issuerName: string | undefined;
issuerPath: Array<{
id: number | string;
identifier: string;
name: string;
profile: any; // TODO
}>;
modules: FnModules[];
name: string;
optimizationBailout?: string;
optional: boolean;
prefetched: boolean;
profile: any; // TODO
providedExports?: any; // TODO
reasons: Reason[];
size: number;
source?: string;
usedExports?: boolean;
warnings: number;
}
interface ToJsonOutput {
_showErrors: boolean;
_showWarnings: boolean;
assets?: Array<{
chunks: Array<number | string>;
chunkNames: string[];
emitted: boolean;
isOverSizeLimit?: boolean;
name: string;
size: number;
}>;
assetsByChunkName?: Record<string, string | string[]>;
builtAt?: number;
children?: Array<ToJsonOutput & { name?: string }>;
chunks?: Array<{
children: number[];
childrenByOrder: Record<string, number[]>;
entry: boolean;
files: string[];
filteredModules?: number;
hash?: string;
id: number | string;
initial: boolean;
modules?: FnModules[];
names: string[];
origins?: Array<{
moduleId?: string | number;
module: string;
moduleIdentifier: string;
moduleName: string;
loc: string;
request: string;
reasons: string[];
}>;
parents: number[];
reason?: string;
recorded?: boolean;
rendered: boolean;
size: number;
siblings: number[];
}>;
entrypoints?: Record<string, ChunkGroup>;
errors: string[];
env?: Record<string, any>;
filteredAssets?: number;
filteredModules?: boolean;
hash?: string;
modules?: FnModules[];
namedChunkGroups?: Record<string, ChunkGroup>;
needAdditionalPass?: boolean;
outputPath?: string;
publicPath?: string;
time?: number;
version?: string;
warnings: string[];
}
type StatsExcludeFilter = string | string[] | RegExp | RegExp[] | ((assetName: string) => boolean) | Array<(assetName: string) => boolean>;
interface ToStringOptionsObject extends ToJsonOptionsObject {
/** `webpack --colors` equivalent */
colors?: boolean | string;
}
type ToStringOptions = Preset | ToStringOptionsObject;
}
/**
* Plugins
*/
class BannerPlugin extends Plugin {
constructor(options: string | BannerPlugin.Options);
}
namespace BannerPlugin {
type Filter = string | RegExp;
interface Options {
banner: string;
entryOnly?: boolean;
exclude?: Filter | Filter[];
include?: Filter | Filter[];
raw?: boolean;
test?: Filter | Filter[];
}
}
class ContextReplacementPlugin extends Plugin {
constructor(resourceRegExp: any, newContentResource?: any, newContentRecursive?: any, newContentRegExp?: any);
}
class DefinePlugin extends Plugin {
constructor(definitions: {[key: string]: DefinePlugin.CodeValueObject});
static runtimeValue(
fn: ({ module }: { module: compilation.Module }) => DefinePlugin.CodeValuePrimitive,
fileDependencies?: true | string[]
): DefinePlugin.RuntimeValue;
}
namespace DefinePlugin {
class RuntimeValue {
constructor(
fn: ({ module }: { module: compilation.Module }) => CodeValuePrimitive,
fileDependencies?: string[]
);
exec(parser: compilation.normalModuleFactory.Parser): CodeValuePrimitive;
}
type CodeValuePrimitive = string | number | boolean | RegExp | RuntimeValue | null | undefined;
type CodeValueObject = CodeValuePrimitive | {[key: string]: CodeValueObject};
}
class DllPlugin extends Plugin {
constructor(options: DllPlugin.Options | DllPlugin.Options[]);
}
namespace DllPlugin {
interface Options {
/**
* The context of requests in the manifest file.
*
* Defaults to the webpack context.
*/
context?: string;
/**
* The name of the exposed DLL function (keep consistent with `output.library`).
*/
name: string;
/**
* The absolute path to the manifest json file (output).
*/
path: string;
}
}
class DllReferencePlugin extends Plugin {
constructor(options: DllReferencePlugin.Options);
}
namespace DllReferencePlugin {
interface Options {
/**
* The mappings from the request to module ID.
*
* Defaults to `manifest.content`.
*/
content?: any;
/**
* The context of requests in the manifest (or content property).
*
* This is an <b>absolute path</b>.
*/
context: string;
/**
* An object containing `content` and `name`.
*/
manifest: { content: string, name: string } | string;
/**
* The name where the DLL is exposed.
*
* Defaults to `manifest.name`.
*
* See also `externals`.
*/
name?: string;
/**
* The prefix which is used for accessing the content of the DLL.
*/
scope?: string;
/**
* The type how the DLL is exposed.
*
* Defaults to `"var"`.
*
* See also `externals`.
*/
sourceType?: string;
}
}
class EvalSourceMapDevToolPlugin extends Plugin {
constructor(options?: false | string | EvalSourceMapDevToolPlugin.Options);
}
namespace EvalSourceMapDevToolPlugin {
interface Options {
append?: false | string;
columns?: boolean;
lineToLine?: boolean | {
exclude?: Condition | Condition[];
include?: Condition | Condition[];
test?: Condition | Condition[];
};
module?: boolean;
moduleFilenameTemplate?: string;
sourceRoot?: string;
}
}
class ExtendedAPIPlugin extends Plugin {
constructor();
}
class ExternalsPlugin extends Plugin {
constructor(type: string, externals: ExternalsElement);
}
class HashedModuleIdsPlugin extends Plugin {
constructor(options?: {
hashFunction?: string,
hashDigest?: string,
hashDigestLength?: number
});
}
class HotModuleReplacementPlugin extends Plugin {
constructor(options?: any);
}
class IgnorePlugin extends Plugin {
constructor(requestRegExp: any, contextRegExp?: any);
}
class LoaderOptionsPlugin extends Plugin {
constructor(options: any);
}
/** @deprecated use config.optimization.namedModules */
class NamedModulesPlugin extends Plugin {
constructor();
}
class NamedChunksPlugin extends Plugin {
constructor(nameResolver?: (chunk: any) => string | null);
}
/** @deprecated use config.optimization.noEmitOnErrors */
class NoEmitOnErrorsPlugin extends Plugin {
constructor();
}
class NormalModuleReplacementPlugin extends Plugin {
constructor(resourceRegExp: any, newResource: any);
}
class PrefetchPlugin extends Plugin {
// tslint:disable-next-line:unified-signatures
constructor(context: any, request: any);
constructor(request: any);
}
class ProgressPlugin extends Plugin {
constructor(options?: ProgressPlugin.Options | ProgressPlugin.Handler);
}
namespace ProgressPlugin {
/**
* A handler function which will be called when webpack hooks report progress
*/
type Handler = (percentage: number, msg: string, ...args: string[]) => void;
interface Options {
/**
* Show active modules count and one active module in progress message
* Default: true
*/
activeModules?: boolean;
/**
* Show entries count in progress message
* Default: false
*/
entries?: boolean;
/**
* Function that executes for every progress step
*/
handler?: Handler;
/**
* Show modules count in progress message
* Default: true
*/
modules?: boolean;
/**
* Minimum modules count to start with, only for mode = modules
* Default: 500
*/
modulesCount?: number;
/**
* Collect profile data for progress steps
* Default: false
*/
profile?: boolean | null;
}
}
class EnvironmentPlugin extends Plugin {
constructor(envs: string[] | { [key: string]: any });
}
class ProvidePlugin extends Plugin {
constructor(definitions: { [key: string]: any });
}
class SplitChunksPlugin extends Plugin {
constructor(options?: Options.SplitChunksOptions);
}
class SourceMapDevToolPlugin extends Plugin {
constructor(options?: null | false | string | SourceMapDevToolPlugin.Options);
}
namespace SourceMapDevToolPlugin {
/** @todo extend EvalSourceMapDevToolPlugin.Options */
interface Options {
append?: false | string;
columns?: boolean;
exclude?: Condition | Condition[];
fallbackModuleFilenameTemplate?: string;
filename?: null | false | string;
include?: Condition | Condition[];
lineToLine?: boolean | {
exclude?: Condition | Condition[];
include?: Condition | Condition[];
test?: Condition | Condition[];
};
module?: boolean;
moduleFilenameTemplate?: string;
noSources?: boolean;
publicPath?: string;
sourceRoot?: null | string;
test?: Condition | Condition[];
}
}
class WatchIgnorePlugin extends Plugin {
constructor(paths: Array<string | RegExp>);
}
class SingleEntryPlugin extends Plugin {
constructor(context: string, entry: string, name: string);
}
namespace optimize {
/** @deprecated use config.optimization.concatenateModules */
class ModuleConcatenationPlugin extends Plugin { }
class AggressiveMergingPlugin extends Plugin {
constructor(options?: AggressiveMergingPlugin.Options);
}
namespace AggressiveMergingPlugin {
interface Options {
/**
* When options.moveToParents is set, moving to an entry chunk is more expensive.
* Defaults to 10, which means moving to an entry chunk is ten times more expensive than moving to a
* normal chunk.
*/
entryChunkMultiplicator?: number;
/**
* A factor which defines the minimum required size reduction for chunk merging.
* Defaults to 1.5 which means that the total size needs to be reduced by 50% for chunk merging.
*/
minSizeReduce?: number;
/**
* When set, modules that are not in both merged chunks are moved to all parents of the chunk.
* Defaults to false.
*/
moveToParents?: boolean;
}
}
class AggressiveSplittingPlugin extends Plugin {
constructor(options?: AggressiveSplittingPlugin.Options);
}
namespace AggressiveSplittingPlugin {
interface Options {
/**
* Size in byte.
* Only chunks bigger than the specified minSize are stored in records.
* This ensures the chunks fill up as your application grows,
* instead of creating too many chunks for every change.
*
* Default: 30720
*/
minSize: 30000;
/**
* Size in byte.
* maximum size prefered for each chunk.
*
* Default: 51200
*/
maxSize: 50000;
chunkOverhead: 0;
entryChunkMultiplicator: 1;
}
}
/** @deprecated */
class DedupePlugin extends Plugin {
constructor();
}
class LimitChunkCountPlugin extends Plugin {
constructor(options: any);
}
class MinChunkSizePlugin extends Plugin {
constructor(options: any);
}
class OccurrenceOrderPlugin extends Plugin {
constructor(preferEntry: boolean);
}
class UglifyJsPlugin extends Plugin {
constructor(options?: UglifyJsPlugin.Options);
}
namespace UglifyJsPlugin {
type CommentFilter = (astNode: any, comment: any) => boolean;
interface Options extends UglifyJS.MinifyOptions {
beautify?: boolean;
comments?: boolean | RegExp | CommentFilter;
exclude?: Condition | Condition[];
include?: Condition | Condition[];
/** Parallelization can speedup your build significantly and is therefore highly recommended. */
parallel?: boolean | { cache: boolean, workers: boolean | number };
sourceMap?: boolean;
test?: Condition | Condition[];
}
}
}
namespace dependencies {
}
namespace loader {
interface Loader extends Function {
(this: LoaderContext, source: string | Buffer, sourceMap?: RawSourceMap): string | Buffer | void | undefined;
/**
* The order of chained loaders are always called from right to left.
* But, in some cases, loaders do not care about the results of the previous loader or the resource.
* They only care for metadata. The pitch method on the loaders is called from left to right before the loaders are called (from right to left).
* If a loader delivers a result in the pitch method the process turns around and skips the remaining loaders,
* continuing with the calls to the more left loaders. data can be passed between pitch and normal call.
*/
pitch?(this: LoaderContext, remainingRequest: string, precedingRequest: string, data: any): any;
/**
* By default, the resource file is treated as utf-8 string and passed as String to the loader.
* By setting raw to true the loader is passed the raw Buffer.
* Every loader is allowed to deliver its result as String or as Buffer.
* The compiler converts them between loaders.
*/
raw?: boolean;
}
type loaderCallback = (
err: Error | undefined | null,
content?: string | Buffer,
sourceMap?: string | RawSourceMap
) => void;
interface LoaderContext {
/**
* Loader API version. Currently 2.
* This is useful for providing backwards compatibility.
* Using the version you can specify custom logic or fallbacks for breaking changes.
*/
version: string;
/**
* The directory of the module. Can be used as context for resolving other stuff.
* In the example: /abc because resource.js is in this directory
*/
context: string;
/**
* Starting with webpack 4, the formerly `this.options.context` is provided as `this.rootContext`.
*/
rootContext: string;
/**
* The resolved request string.
* In the example: "/abc/loader1.js?xyz!/abc/node_modules/loader2/index.js!/abc/resource.js?rrr"
*/
request: string;
/**
* A string or any object. The query of the request for the current loader.
*/
query: any;
/**
* A data object shared between the pitch and the normal phase.
*/
data?: any;
callback: loaderCallback;
/**
* Make this loader async.
*/
async(): loaderCallback | undefined;
/**
* Make this loader result cacheable. By default it's not cacheable.
* A cacheable loader must have a deterministic result, when inputs and dependencies haven't changed.
* This means the loader shouldn't have other dependencies than specified with this.addDependency.
* Most loaders are deterministic and cacheable.
*/
cacheable(flag?: boolean): void;
/**
* An array of all the loaders. It is writeable in the pitch phase.
* loaders = [{request: string, path: string, query: string, module: function}]
*
* In the example:
* [
* { request: "/abc/loader1.js?xyz",
* path: "/abc/loader1.js",
* query: "?xyz",
* module: [Function]
* },
* { request: "/abc/node_modules/loader2/index.js",
* path: "/abc/node_modules/loader2/index.js",
* query: "",
* module: [Function]
* }
* ]
*/
loaders: any[];
/**
* The index in the loaders array of the current loader.
* In the example: in loader1: 0, in loader2: 1
*/
loaderIndex: number;
/**
* The resource part of the request, including query.
* In the example: "/abc/resource.js?rrr"
*/
resource: string;
/**
* The resource file.
* In the example: "/abc/resource.js"
*/
resourcePath: string;
/**
* The query of the resource.
* In the example: "?rrr"
*/
resourceQuery: string;
/**
* Emit a warning.
*/
emitWarning(message: string | Error): void;
/**
* Emit a error.
*/
emitError(message: string | Error): void;
/**
* Execute some code fragment like a module.
*
* Don't use require(this.resourcePath), use this function to make loaders chainable!
*
*/
exec(code: string, filename: string): any;
/**
* Resolves the given request to a module, applies all configured loaders and calls
* back with the generated source, the sourceMap and the module instance (usually an
* instance of NormalModule). Use this function if you need to know the source code
* of another module to generate the result.
*/
loadModule(request: string, callback: (err: Error | null, source: string, sourceMap: RawSourceMap, module: Module) => void): any;
/**
* Resolve a request like a require expression.
*/
resolve(context: string, request: string, callback: (err: Error, result: string) => void): any;
/**
* Resolve a request like a require expression.
*/
resolveSync(context: string, request: string): string;
/**
* Adds a file as dependency of the loader result in order to make them watchable.
* For example, html-loader uses this technique as it finds src and src-set attributes.
* Then, it sets the url's for those attributes as dependencies of the html file that is parsed.
*/
addDependency(file: string): void;
/**
* Adds a file as dependency of the loader result in order to make them watchable.
* For example, html-loader uses this technique as it finds src and src-set attributes.
* Then, it sets the url's for those attributes as dependencies of the html file that is parsed.
*/
dependency(file: string): void;
/**
* Add a directory as dependency of the loader result.
*/
addContextDependency(directory: string): void;
/**
* Remove all dependencies of the loader result. Even initial dependencies and these of other loaders. Consider using pitch.
*/
clearDependencies(): void;
/**
* Pass values to the next loader.
* If you know what your result exports if executed as module, set this value here (as a only element array).
*/
value: any;
/**
* Passed from the last loader.
* If you would execute the input argument as module, consider reading this variable for a shortcut (for performance).
*/
inputValue: any;
/**
* A boolean flag. It is set when in debug mode.
*/
debug: boolean;
/**
* Should the result be minimized.
*/
minimize: boolean;
/**
* Should a SourceMap be generated.
*/
sourceMap: boolean;
/**
* Target of compilation. Passed from configuration options.
* Example values: "web", "node"
*/
target: 'web' | 'webworker' | 'async-node' | 'node' | 'electron-main' | 'electron-renderer' | 'node-webkit' | string;
/**
* This boolean is set to true when this is compiled by webpack.
*
* Loaders were originally designed to also work as Babel transforms.
* Therefore if you write a loader that works for both, you can use this property to know if
* there is access to additional loaderContext and webpack features.
*/
webpack: boolean;
/**
* Emit a file. This is webpack-specific.
*/
emitFile(name: string, content: Buffer | string, sourceMap: any): void;
/**
* Access to the compilation's inputFileSystem property.
*/
fs: any;
/**
* Which mode is webpack running.
*/
mode: 'production' | 'development' | 'none';
/**
* Hacky access to the Compilation object of webpack.
*/
_compilation: any;
/**
* Hacky access to the Compiler object of webpack.
*/
_compiler: Compiler;
/**
* Hacky access to the Module object being loaded.
*/
_module: any;
/** Flag if HMR is enabled */
hot: boolean;
}
}
namespace Template {
function getFunctionContent(fn: (...args: any[]) => any): string;
function toIdentifier(str: string): string;
function toComment(str: string): string;
function toNormalComment(str: string): string;
function toPath(str: string): string;
function numberToIdentifer(n: number): string;
function indent(s: string | string[]): string;
function prefix(s: string | string[], prefix: string): string;
function asString(str: string | string[]): string;
function getModulesArrayBounds(modules: ReadonlyArray<{
id: string | number;
}>): [number, number] | false;
function renderChunkModules(
chunk: compilation.Chunk,
filterFn: (module: compilation.Module, num: number) => boolean,
moduleTemplate: compilation.ModuleTemplate,
dependencyTemplates: any,
prefix?: string,
): ConcatSource;
}
/** @deprecated */
namespace compiler {
/** @deprecated use webpack.Compiler */
// tslint:disable-next-line:no-unnecessary-qualifier
type Compiler = webpack.Compiler;
/** @deprecated use webpack.Compiler.Watching */
type Watching = Compiler.Watching;
/** @deprecated use webpack.Compiler.WatchOptions */
type WatchOptions = Compiler.WatchOptions;
/** @deprecated use webpack.Stats */
// tslint:disable-next-line:no-unnecessary-qualifier
type Stats = webpack.Stats;
/** @deprecated use webpack.Stats.ToJsonOptions */
type StatsOptions = Stats.ToJsonOptions;
/** @deprecated use webpack.Stats.ToStringOptions */
type StatsToStringOptions = Stats.ToStringOptions;
/** @deprecated use webpack.Compiler.Handler */
type CompilerCallback = Compiler.Handler;
}
/** @deprecated use webpack.Options.Performance */
type PerformanceOptions = Options.Performance;
/** @deprecated use webpack.Options.WatchOptions */
type WatchOptions = Options.WatchOptions;
/** @deprecated use webpack.EvalSourceMapDevToolPlugin.Options */
type EvalSourceMapDevToolPluginOptions = EvalSourceMapDevToolPlugin.Options;
/** @deprecated use webpack.SourceMapDevToolPlugin.Options */
type SourceMapDevToolPluginOptions = SourceMapDevToolPlugin.Options;
/** @deprecated use webpack.optimize.UglifyJsPlugin.CommentFilter */
type UglifyCommentFunction = optimize.UglifyJsPlugin.CommentFilter;
/** @deprecated use webpack.optimize.UglifyJsPlugin.Options */
type UglifyPluginOptions = optimize.UglifyJsPlugin.Options;
}