File size: 85,373 Bytes
f9f0fec |
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 |
/**
* The `node:util` module supports the needs of Node.js internal APIs. Many of the
* utilities are useful for application and module developers as well. To access
* it:
*
* ```js
* const util = require('node:util');
* ```
* @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/util.js)
*/
declare module "util" {
import * as types from "node:util/types";
export interface InspectOptions {
/**
* If `true`, object's non-enumerable symbols and properties are included in the formatted result.
* `WeakMap` and `WeakSet` entries are also included as well as user defined prototype properties (excluding method properties).
* @default false
*/
showHidden?: boolean | undefined;
/**
* Specifies the number of times to recurse while formatting object.
* This is useful for inspecting large objects.
* To recurse up to the maximum call stack size pass `Infinity` or `null`.
* @default 2
*/
depth?: number | null | undefined;
/**
* If `true`, the output is styled with ANSI color codes. Colors are customizable.
*/
colors?: boolean | undefined;
/**
* If `false`, `[util.inspect.custom](depth, opts, inspect)` functions are not invoked.
* @default true
*/
customInspect?: boolean | undefined;
/**
* If `true`, `Proxy` inspection includes the target and handler objects.
* @default false
*/
showProxy?: boolean | undefined;
/**
* Specifies the maximum number of `Array`, `TypedArray`, `WeakMap`, and `WeakSet` elements
* to include when formatting. Set to `null` or `Infinity` to show all elements.
* Set to `0` or negative to show no elements.
* @default 100
*/
maxArrayLength?: number | null | undefined;
/**
* Specifies the maximum number of characters to
* include when formatting. Set to `null` or `Infinity` to show all elements.
* Set to `0` or negative to show no characters.
* @default 10000
*/
maxStringLength?: number | null | undefined;
/**
* The length at which input values are split across multiple lines.
* Set to `Infinity` to format the input as a single line
* (in combination with `compact` set to `true` or any number >= `1`).
* @default 80
*/
breakLength?: number | undefined;
/**
* Setting this to `false` causes each object key
* to be displayed on a new line. It will also add new lines to text that is
* longer than `breakLength`. If set to a number, the most `n` inner elements
* are united on a single line as long as all properties fit into
* `breakLength`. Short array elements are also grouped together. Note that no
* text will be reduced below 16 characters, no matter the `breakLength` size.
* For more information, see the example below.
* @default true
*/
compact?: boolean | number | undefined;
/**
* If set to `true` or a function, all properties of an object, and `Set` and `Map`
* entries are sorted in the resulting string.
* If set to `true` the default sort is used.
* If set to a function, it is used as a compare function.
*/
sorted?: boolean | ((a: string, b: string) => number) | undefined;
/**
* If set to `true`, getters are going to be
* inspected as well. If set to `'get'` only getters without setter are going
* to be inspected. If set to `'set'` only getters having a corresponding
* setter are going to be inspected. This might cause side effects depending on
* the getter function.
* @default false
*/
getters?: "get" | "set" | boolean | undefined;
/**
* If set to `true`, an underscore is used to separate every three digits in all bigints and numbers.
* @default false
*/
numericSeparator?: boolean | undefined;
}
export type Style =
| "special"
| "number"
| "bigint"
| "boolean"
| "undefined"
| "null"
| "string"
| "symbol"
| "date"
| "regexp"
| "module";
export type CustomInspectFunction = (depth: number, options: InspectOptionsStylized) => any; // TODO: , inspect: inspect
export interface InspectOptionsStylized extends InspectOptions {
stylize(text: string, styleType: Style): string;
}
/**
* The `util.format()` method returns a formatted string using the first argument
* as a `printf`\-like format string which can contain zero or more format
* specifiers. Each specifier is replaced with the converted value from the
* corresponding argument. Supported specifiers are:
*
* If a specifier does not have a corresponding argument, it is not replaced:
*
* ```js
* util.format('%s:%s', 'foo');
* // Returns: 'foo:%s'
* ```
*
* Values that are not part of the format string are formatted using`util.inspect()` if their type is not `string`.
*
* If there are more arguments passed to the `util.format()` method than the
* number of specifiers, the extra arguments are concatenated to the returned
* string, separated by spaces:
*
* ```js
* util.format('%s:%s', 'foo', 'bar', 'baz');
* // Returns: 'foo:bar baz'
* ```
*
* If the first argument does not contain a valid format specifier, `util.format()`returns a string that is the concatenation of all arguments separated by spaces:
*
* ```js
* util.format(1, 2, 3);
* // Returns: '1 2 3'
* ```
*
* If only one argument is passed to `util.format()`, it is returned as it is
* without any formatting:
*
* ```js
* util.format('%% %s');
* // Returns: '%% %s'
* ```
*
* `util.format()` is a synchronous method that is intended as a debugging tool.
* Some input values can have a significant performance overhead that can block the
* event loop. Use this function with care and never in a hot code path.
* @since v0.5.3
* @param format A `printf`-like format string.
*/
export function format(format?: any, ...param: any[]): string;
/**
* This function is identical to {@link format}, except in that it takes
* an `inspectOptions` argument which specifies options that are passed along to {@link inspect}.
*
* ```js
* util.formatWithOptions({ colors: true }, 'See object %O', { foo: 42 });
* // Returns 'See object { foo: 42 }', where `42` is colored as a number
* // when printed to a terminal.
* ```
* @since v10.0.0
*/
export function formatWithOptions(inspectOptions: InspectOptions, format?: any, ...param: any[]): string;
/**
* Returns the string name for a numeric error code that comes from a Node.js API.
* The mapping between error codes and error names is platform-dependent.
* See `Common System Errors` for the names of common errors.
*
* ```js
* fs.access('file/that/does/not/exist', (err) => {
* const name = util.getSystemErrorName(err.errno);
* console.error(name); // ENOENT
* });
* ```
* @since v9.7.0
*/
export function getSystemErrorName(err: number): string;
/**
* Returns a Map of all system error codes available from the Node.js API.
* The mapping between error codes and error names is platform-dependent.
* See `Common System Errors` for the names of common errors.
*
* ```js
* fs.access('file/that/does/not/exist', (err) => {
* const errorMap = util.getSystemErrorMap();
* const name = errorMap.get(err.errno);
* console.error(name); // ENOENT
* });
* ```
* @since v16.0.0, v14.17.0
*/
export function getSystemErrorMap(): Map<number, [string, string]>;
/**
* The `util.log()` method prints the given `string` to `stdout` with an included
* timestamp.
*
* ```js
* const util = require('node:util');
*
* util.log('Timestamped message.');
* ```
* @since v0.3.0
* @deprecated Since v6.0.0 - Use a third party module instead.
*/
export function log(string: string): void;
/**
* Returns the `string` after replacing any surrogate code points
* (or equivalently, any unpaired surrogate code units) with the
* Unicode "replacement character" U+FFFD.
* @since v16.8.0, v14.18.0
*/
export function toUSVString(string: string): string;
/**
* Creates and returns an `AbortController` instance whose `AbortSignal` is marked
* as transferable and can be used with `structuredClone()` or `postMessage()`.
* @since v18.11.0
* @experimental
* @returns A transferable AbortController
*/
export function transferableAbortController(): AbortController;
/**
* Marks the given `AbortSignal` as transferable so that it can be used with`structuredClone()` and `postMessage()`.
*
* ```js
* const signal = transferableAbortSignal(AbortSignal.timeout(100));
* const channel = new MessageChannel();
* channel.port2.postMessage(signal, [signal]);
* ```
* @since v18.11.0
* @experimental
* @param signal The AbortSignal
* @returns The same AbortSignal
*/
export function transferableAbortSignal(signal: AbortSignal): AbortSignal;
/**
* Listens to abort event on the provided `signal` and
* returns a promise that is fulfilled when the `signal` is
* aborted. If the passed `resource` is garbage collected before the `signal` is
* aborted, the returned promise shall remain pending indefinitely.
*
* ```js
* import { aborted } from 'node:util';
*
* const dependent = obtainSomethingAbortable();
*
* aborted(dependent.signal, dependent).then(() => {
* // Do something when dependent is aborted.
* });
*
* dependent.on('event', () => {
* dependent.abort();
* });
* ```
* @since v19.7.0
* @experimental
* @param resource Any non-null entity, reference to which is held weakly.
*/
export function aborted(signal: AbortSignal, resource: any): Promise<void>;
/**
* The `util.inspect()` method returns a string representation of `object` that is
* intended for debugging. The output of `util.inspect` may change at any time
* and should not be depended upon programmatically. Additional `options` may be
* passed that alter the result.`util.inspect()` will use the constructor's name and/or `@@toStringTag` to make
* an identifiable tag for an inspected value.
*
* ```js
* class Foo {
* get [Symbol.toStringTag]() {
* return 'bar';
* }
* }
*
* class Bar {}
*
* const baz = Object.create(null, { [Symbol.toStringTag]: { value: 'foo' } });
*
* util.inspect(new Foo()); // 'Foo [bar] {}'
* util.inspect(new Bar()); // 'Bar {}'
* util.inspect(baz); // '[foo] {}'
* ```
*
* Circular references point to their anchor by using a reference index:
*
* ```js
* const { inspect } = require('node:util');
*
* const obj = {};
* obj.a = [obj];
* obj.b = {};
* obj.b.inner = obj.b;
* obj.b.obj = obj;
*
* console.log(inspect(obj));
* // <ref *1> {
* // a: [ [Circular *1] ],
* // b: <ref *2> { inner: [Circular *2], obj: [Circular *1] }
* // }
* ```
*
* The following example inspects all properties of the `util` object:
*
* ```js
* const util = require('node:util');
*
* console.log(util.inspect(util, { showHidden: true, depth: null }));
* ```
*
* The following example highlights the effect of the `compact` option:
*
* ```js
* const util = require('node:util');
*
* const o = {
* a: [1, 2, [[
* 'Lorem ipsum dolor sit amet,\nconsectetur adipiscing elit, sed do ' +
* 'eiusmod \ntempor incididunt ut labore et dolore magna aliqua.',
* 'test',
* 'foo']], 4],
* b: new Map([['za', 1], ['zb', 'test']]),
* };
* console.log(util.inspect(o, { compact: true, depth: 5, breakLength: 80 }));
*
* // { a:
* // [ 1,
* // 2,
* // [ [ 'Lorem ipsum dolor sit amet,\nconsectetur [...]', // A long line
* // 'test',
* // 'foo' ] ],
* // 4 ],
* // b: Map(2) { 'za' => 1, 'zb' => 'test' } }
*
* // Setting `compact` to false or an integer creates more reader friendly output.
* console.log(util.inspect(o, { compact: false, depth: 5, breakLength: 80 }));
*
* // {
* // a: [
* // 1,
* // 2,
* // [
* // [
* // 'Lorem ipsum dolor sit amet,\n' +
* // 'consectetur adipiscing elit, sed do eiusmod \n' +
* // 'tempor incididunt ut labore et dolore magna aliqua.',
* // 'test',
* // 'foo'
* // ]
* // ],
* // 4
* // ],
* // b: Map(2) {
* // 'za' => 1,
* // 'zb' => 'test'
* // }
* // }
*
* // Setting `breakLength` to e.g. 150 will print the "Lorem ipsum" text in a
* // single line.
* ```
*
* The `showHidden` option allows [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) and
* [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) entries to be
* inspected. If there are more entries than `maxArrayLength`, there is no
* guarantee which entries are displayed. That means retrieving the same [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) entries twice may
* result in different output. Furthermore, entries
* with no remaining strong references may be garbage collected at any time.
*
* ```js
* const { inspect } = require('node:util');
*
* const obj = { a: 1 };
* const obj2 = { b: 2 };
* const weakSet = new WeakSet([obj, obj2]);
*
* console.log(inspect(weakSet, { showHidden: true }));
* // WeakSet { { a: 1 }, { b: 2 } }
* ```
*
* The `sorted` option ensures that an object's property insertion order does not
* impact the result of `util.inspect()`.
*
* ```js
* const { inspect } = require('node:util');
* const assert = require('node:assert');
*
* const o1 = {
* b: [2, 3, 1],
* a: '`a` comes before `b`',
* c: new Set([2, 3, 1]),
* };
* console.log(inspect(o1, { sorted: true }));
* // { a: '`a` comes before `b`', b: [ 2, 3, 1 ], c: Set(3) { 1, 2, 3 } }
* console.log(inspect(o1, { sorted: (a, b) => b.localeCompare(a) }));
* // { c: Set(3) { 3, 2, 1 }, b: [ 2, 3, 1 ], a: '`a` comes before `b`' }
*
* const o2 = {
* c: new Set([2, 1, 3]),
* a: '`a` comes before `b`',
* b: [2, 3, 1],
* };
* assert.strict.equal(
* inspect(o1, { sorted: true }),
* inspect(o2, { sorted: true }),
* );
* ```
*
* The `numericSeparator` option adds an underscore every three digits to all
* numbers.
*
* ```js
* const { inspect } = require('node:util');
*
* const thousand = 1_000;
* const million = 1_000_000;
* const bigNumber = 123_456_789n;
* const bigDecimal = 1_234.123_45;
*
* console.log(inspect(thousand, { numericSeparator: true }));
* // 1_000
* console.log(inspect(million, { numericSeparator: true }));
* // 1_000_000
* console.log(inspect(bigNumber, { numericSeparator: true }));
* // 123_456_789n
* console.log(inspect(bigDecimal, { numericSeparator: true }));
* // 1_234.123_45
* ```
*
* `util.inspect()` is a synchronous method intended for debugging. Its maximum
* output length is approximately 128 MiB. Inputs that result in longer output will
* be truncated.
* @since v0.3.0
* @param object Any JavaScript primitive or `Object`.
* @return The representation of `object`.
*/
export function inspect(object: any, showHidden?: boolean, depth?: number | null, color?: boolean): string;
export function inspect(object: any, options?: InspectOptions): string;
export namespace inspect {
let colors: NodeJS.Dict<[number, number]>;
let styles: {
[K in Style]: string;
};
let defaultOptions: InspectOptions;
/**
* Allows changing inspect settings from the repl.
*/
let replDefaults: InspectOptions;
/**
* That can be used to declare custom inspect functions.
*/
const custom: unique symbol;
}
/**
* Alias for [`Array.isArray()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray).
*
* Returns `true` if the given `object` is an `Array`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isArray([]);
* // Returns: true
* util.isArray(new Array());
* // Returns: true
* util.isArray({});
* // Returns: false
* ```
* @since v0.6.0
* @deprecated Since v4.0.0 - Use `isArray` instead.
*/
export function isArray(object: unknown): object is unknown[];
/**
* Returns `true` if the given `object` is a `RegExp`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isRegExp(/some regexp/);
* // Returns: true
* util.isRegExp(new RegExp('another regexp'));
* // Returns: true
* util.isRegExp({});
* // Returns: false
* ```
* @since v0.6.0
* @deprecated Since v4.0.0 - Deprecated
*/
export function isRegExp(object: unknown): object is RegExp;
/**
* Returns `true` if the given `object` is a `Date`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isDate(new Date());
* // Returns: true
* util.isDate(Date());
* // false (without 'new' returns a String)
* util.isDate({});
* // Returns: false
* ```
* @since v0.6.0
* @deprecated Since v4.0.0 - Use {@link types.isDate} instead.
*/
export function isDate(object: unknown): object is Date;
/**
* Returns `true` if the given `object` is an `Error`. Otherwise, returns`false`.
*
* ```js
* const util = require('node:util');
*
* util.isError(new Error());
* // Returns: true
* util.isError(new TypeError());
* // Returns: true
* util.isError({ name: 'Error', message: 'an error occurred' });
* // Returns: false
* ```
*
* This method relies on `Object.prototype.toString()` behavior. It is
* possible to obtain an incorrect result when the `object` argument manipulates`@@toStringTag`.
*
* ```js
* const util = require('node:util');
* const obj = { name: 'Error', message: 'an error occurred' };
*
* util.isError(obj);
* // Returns: false
* obj[Symbol.toStringTag] = 'Error';
* util.isError(obj);
* // Returns: true
* ```
* @since v0.6.0
* @deprecated Since v4.0.0 - Use {@link types.isNativeError} instead.
*/
export function isError(object: unknown): object is Error;
/**
* Usage of `util.inherits()` is discouraged. Please use the ES6 `class` and`extends` keywords to get language level inheritance support. Also note
* that the two styles are [semantically incompatible](https://github.com/nodejs/node/issues/4179).
*
* Inherit the prototype methods from one [constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/constructor) into another. The
* prototype of `constructor` will be set to a new object created from`superConstructor`.
*
* This mainly adds some input validation on top of`Object.setPrototypeOf(constructor.prototype, superConstructor.prototype)`.
* As an additional convenience, `superConstructor` will be accessible
* through the `constructor.super_` property.
*
* ```js
* const util = require('node:util');
* const EventEmitter = require('node:events');
*
* function MyStream() {
* EventEmitter.call(this);
* }
*
* util.inherits(MyStream, EventEmitter);
*
* MyStream.prototype.write = function(data) {
* this.emit('data', data);
* };
*
* const stream = new MyStream();
*
* console.log(stream instanceof EventEmitter); // true
* console.log(MyStream.super_ === EventEmitter); // true
*
* stream.on('data', (data) => {
* console.log(`Received data: "${data}"`);
* });
* stream.write('It works!'); // Received data: "It works!"
* ```
*
* ES6 example using `class` and `extends`:
*
* ```js
* const EventEmitter = require('node:events');
*
* class MyStream extends EventEmitter {
* write(data) {
* this.emit('data', data);
* }
* }
*
* const stream = new MyStream();
*
* stream.on('data', (data) => {
* console.log(`Received data: "${data}"`);
* });
* stream.write('With ES6');
* ```
* @since v0.3.0
* @legacy Use ES2015 class syntax and `extends` keyword instead.
*/
export function inherits(constructor: unknown, superConstructor: unknown): void;
export type DebugLoggerFunction = (msg: string, ...param: unknown[]) => void;
export interface DebugLogger extends DebugLoggerFunction {
enabled: boolean;
}
/**
* The `util.debuglog()` method is used to create a function that conditionally
* writes debug messages to `stderr` based on the existence of the `NODE_DEBUG`environment variable. If the `section` name appears within the value of that
* environment variable, then the returned function operates similar to `console.error()`. If not, then the returned function is a no-op.
*
* ```js
* const util = require('node:util');
* const debuglog = util.debuglog('foo');
*
* debuglog('hello from foo [%d]', 123);
* ```
*
* If this program is run with `NODE_DEBUG=foo` in the environment, then
* it will output something like:
*
* ```console
* FOO 3245: hello from foo [123]
* ```
*
* where `3245` is the process id. If it is not run with that
* environment variable set, then it will not print anything.
*
* The `section` supports wildcard also:
*
* ```js
* const util = require('node:util');
* const debuglog = util.debuglog('foo-bar');
*
* debuglog('hi there, it\'s foo-bar [%d]', 2333);
* ```
*
* if it is run with `NODE_DEBUG=foo*` in the environment, then it will output
* something like:
*
* ```console
* FOO-BAR 3257: hi there, it's foo-bar [2333]
* ```
*
* Multiple comma-separated `section` names may be specified in the `NODE_DEBUG`environment variable: `NODE_DEBUG=fs,net,tls`.
*
* The optional `callback` argument can be used to replace the logging function
* with a different function that doesn't have any initialization or
* unnecessary wrapping.
*
* ```js
* const util = require('node:util');
* let debuglog = util.debuglog('internals', (debug) => {
* // Replace with a logging function that optimizes out
* // testing if the section is enabled
* debuglog = debug;
* });
* ```
* @since v0.11.3
* @param section A string identifying the portion of the application for which the `debuglog` function is being created.
* @param callback A callback invoked the first time the logging function is called with a function argument that is a more optimized logging function.
* @return The logging function
*/
export function debuglog(section: string, callback?: (fn: DebugLoggerFunction) => void): DebugLogger;
export const debug: typeof debuglog;
/**
* Returns `true` if the given `object` is a `Boolean`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isBoolean(1);
* // Returns: false
* util.isBoolean(0);
* // Returns: false
* util.isBoolean(false);
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `typeof value === 'boolean'` instead.
*/
export function isBoolean(object: unknown): object is boolean;
/**
* Returns `true` if the given `object` is a `Buffer`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isBuffer({ length: 0 });
* // Returns: false
* util.isBuffer([]);
* // Returns: false
* util.isBuffer(Buffer.from('hello world'));
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `isBuffer` instead.
*/
export function isBuffer(object: unknown): object is Buffer;
/**
* Returns `true` if the given `object` is a `Function`. Otherwise, returns`false`.
*
* ```js
* const util = require('node:util');
*
* function Foo() {}
* const Bar = () => {};
*
* util.isFunction({});
* // Returns: false
* util.isFunction(Foo);
* // Returns: true
* util.isFunction(Bar);
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `typeof value === 'function'` instead.
*/
export function isFunction(object: unknown): boolean;
/**
* Returns `true` if the given `object` is strictly `null`. Otherwise, returns`false`.
*
* ```js
* const util = require('node:util');
*
* util.isNull(0);
* // Returns: false
* util.isNull(undefined);
* // Returns: false
* util.isNull(null);
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `value === null` instead.
*/
export function isNull(object: unknown): object is null;
/**
* Returns `true` if the given `object` is `null` or `undefined`. Otherwise,
* returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isNullOrUndefined(0);
* // Returns: false
* util.isNullOrUndefined(undefined);
* // Returns: true
* util.isNullOrUndefined(null);
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `value === undefined || value === null` instead.
*/
export function isNullOrUndefined(object: unknown): object is null | undefined;
/**
* Returns `true` if the given `object` is a `Number`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isNumber(false);
* // Returns: false
* util.isNumber(Infinity);
* // Returns: true
* util.isNumber(0);
* // Returns: true
* util.isNumber(NaN);
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `typeof value === 'number'` instead.
*/
export function isNumber(object: unknown): object is number;
/**
* Returns `true` if the given `object` is strictly an `Object`**and** not a`Function` (even though functions are objects in JavaScript).
* Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isObject(5);
* // Returns: false
* util.isObject(null);
* // Returns: false
* util.isObject({});
* // Returns: true
* util.isObject(() => {});
* // Returns: false
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `value !== null && typeof value === 'object'` instead.
*/
export function isObject(object: unknown): boolean;
/**
* Returns `true` if the given `object` is a primitive type. Otherwise, returns`false`.
*
* ```js
* const util = require('node:util');
*
* util.isPrimitive(5);
* // Returns: true
* util.isPrimitive('foo');
* // Returns: true
* util.isPrimitive(false);
* // Returns: true
* util.isPrimitive(null);
* // Returns: true
* util.isPrimitive(undefined);
* // Returns: true
* util.isPrimitive({});
* // Returns: false
* util.isPrimitive(() => {});
* // Returns: false
* util.isPrimitive(/^$/);
* // Returns: false
* util.isPrimitive(new Date());
* // Returns: false
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `(typeof value !== 'object' && typeof value !== 'function') || value === null` instead.
*/
export function isPrimitive(object: unknown): boolean;
/**
* Returns `true` if the given `object` is a `string`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isString('');
* // Returns: true
* util.isString('foo');
* // Returns: true
* util.isString(String('foo'));
* // Returns: true
* util.isString(5);
* // Returns: false
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `typeof value === 'string'` instead.
*/
export function isString(object: unknown): object is string;
/**
* Returns `true` if the given `object` is a `Symbol`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* util.isSymbol(5);
* // Returns: false
* util.isSymbol('foo');
* // Returns: false
* util.isSymbol(Symbol('foo'));
* // Returns: true
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `typeof value === 'symbol'` instead.
*/
export function isSymbol(object: unknown): object is symbol;
/**
* Returns `true` if the given `object` is `undefined`. Otherwise, returns `false`.
*
* ```js
* const util = require('node:util');
*
* const foo = undefined;
* util.isUndefined(5);
* // Returns: false
* util.isUndefined(foo);
* // Returns: true
* util.isUndefined(null);
* // Returns: false
* ```
* @since v0.11.5
* @deprecated Since v4.0.0 - Use `value === undefined` instead.
*/
export function isUndefined(object: unknown): object is undefined;
/**
* The `util.deprecate()` method wraps `fn` (which may be a function or class) in
* such a way that it is marked as deprecated.
*
* ```js
* const util = require('node:util');
*
* exports.obsoleteFunction = util.deprecate(() => {
* // Do something here.
* }, 'obsoleteFunction() is deprecated. Use newShinyFunction() instead.');
* ```
*
* When called, `util.deprecate()` will return a function that will emit a`DeprecationWarning` using the `'warning'` event. The warning will
* be emitted and printed to `stderr` the first time the returned function is
* called. After the warning is emitted, the wrapped function is called without
* emitting a warning.
*
* If the same optional `code` is supplied in multiple calls to `util.deprecate()`,
* the warning will be emitted only once for that `code`.
*
* ```js
* const util = require('node:util');
*
* const fn1 = util.deprecate(someFunction, someMessage, 'DEP0001');
* const fn2 = util.deprecate(someOtherFunction, someOtherMessage, 'DEP0001');
* fn1(); // Emits a deprecation warning with code DEP0001
* fn2(); // Does not emit a deprecation warning because it has the same code
* ```
*
* If either the `--no-deprecation` or `--no-warnings` command-line flags are
* used, or if the `process.noDeprecation` property is set to `true`_prior_ to
* the first deprecation warning, the `util.deprecate()` method does nothing.
*
* If the `--trace-deprecation` or `--trace-warnings` command-line flags are set,
* or the `process.traceDeprecation` property is set to `true`, a warning and a
* stack trace are printed to `stderr` the first time the deprecated function is
* called.
*
* If the `--throw-deprecation` command-line flag is set, or the`process.throwDeprecation` property is set to `true`, then an exception will be
* thrown when the deprecated function is called.
*
* The `--throw-deprecation` command-line flag and `process.throwDeprecation`property take precedence over `--trace-deprecation` and`process.traceDeprecation`.
* @since v0.8.0
* @param fn The function that is being deprecated.
* @param msg A warning message to display when the deprecated function is invoked.
* @param code A deprecation code. See the `list of deprecated APIs` for a list of codes.
* @return The deprecated function wrapped to emit a warning.
*/
export function deprecate<T extends Function>(fn: T, msg: string, code?: string): T;
/**
* Returns `true` if there is deep strict equality between `val1` and `val2`.
* Otherwise, returns `false`.
*
* See `assert.deepStrictEqual()` for more information about deep strict
* equality.
* @since v9.0.0
*/
export function isDeepStrictEqual(val1: unknown, val2: unknown): boolean;
/**
* Returns `str` with any ANSI escape codes removed.
*
* ```js
* console.log(util.stripVTControlCharacters('\u001B[4mvalue\u001B[0m'));
* // Prints "value"
* ```
* @since v16.11.0
*/
export function stripVTControlCharacters(str: string): string;
/**
* Takes an `async` function (or a function that returns a `Promise`) and returns a
* function following the error-first callback style, i.e. taking
* an `(err, value) => ...` callback as the last argument. In the callback, the
* first argument will be the rejection reason (or `null` if the `Promise`resolved), and the second argument will be the resolved value.
*
* ```js
* const util = require('node:util');
*
* async function fn() {
* return 'hello world';
* }
* const callbackFunction = util.callbackify(fn);
*
* callbackFunction((err, ret) => {
* if (err) throw err;
* console.log(ret);
* });
* ```
*
* Will print:
*
* ```text
* hello world
* ```
*
* The callback is executed asynchronously, and will have a limited stack trace.
* If the callback throws, the process will emit an `'uncaughtException'` event, and if not handled will exit.
*
* Since `null` has a special meaning as the first argument to a callback, if a
* wrapped function rejects a `Promise` with a falsy value as a reason, the value
* is wrapped in an `Error` with the original value stored in a field named`reason`.
*
* ```js
* function fn() {
* return Promise.reject(null);
* }
* const callbackFunction = util.callbackify(fn);
*
* callbackFunction((err, ret) => {
* // When the Promise was rejected with `null` it is wrapped with an Error and
* // the original value is stored in `reason`.
* err && Object.hasOwn(err, 'reason') && err.reason === null; // true
* });
* ```
* @since v8.2.0
* @param fn An `async` function
* @return a callback style function
*/
export function callbackify(fn: () => Promise<void>): (callback: (err: NodeJS.ErrnoException) => void) => void;
export function callbackify<TResult>(
fn: () => Promise<TResult>,
): (callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void;
export function callbackify<T1>(
fn: (arg1: T1) => Promise<void>,
): (arg1: T1, callback: (err: NodeJS.ErrnoException) => void) => void;
export function callbackify<T1, TResult>(
fn: (arg1: T1) => Promise<TResult>,
): (arg1: T1, callback: (err: NodeJS.ErrnoException, result: TResult) => void) => void;
export function callbackify<T1, T2>(
fn: (arg1: T1, arg2: T2) => Promise<void>,
): (arg1: T1, arg2: T2, callback: (err: NodeJS.ErrnoException) => void) => void;
export function callbackify<T1, T2, TResult>(
fn: (arg1: T1, arg2: T2) => Promise<TResult>,
): (arg1: T1, arg2: T2, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void;
export function callbackify<T1, T2, T3>(
fn: (arg1: T1, arg2: T2, arg3: T3) => Promise<void>,
): (arg1: T1, arg2: T2, arg3: T3, callback: (err: NodeJS.ErrnoException) => void) => void;
export function callbackify<T1, T2, T3, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>,
): (arg1: T1, arg2: T2, arg3: T3, callback: (err: NodeJS.ErrnoException | null, result: TResult) => void) => void;
export function callbackify<T1, T2, T3, T4>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: NodeJS.ErrnoException) => void) => void;
export function callbackify<T1, T2, T3, T4, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>,
): (
arg1: T1,
arg2: T2,
arg3: T3,
arg4: T4,
callback: (err: NodeJS.ErrnoException | null, result: TResult) => void,
) => void;
export function callbackify<T1, T2, T3, T4, T5>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: NodeJS.ErrnoException) => void) => void;
export function callbackify<T1, T2, T3, T4, T5, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>,
): (
arg1: T1,
arg2: T2,
arg3: T3,
arg4: T4,
arg5: T5,
callback: (err: NodeJS.ErrnoException | null, result: TResult) => void,
) => void;
export function callbackify<T1, T2, T3, T4, T5, T6>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<void>,
): (
arg1: T1,
arg2: T2,
arg3: T3,
arg4: T4,
arg5: T5,
arg6: T6,
callback: (err: NodeJS.ErrnoException) => void,
) => void;
export function callbackify<T1, T2, T3, T4, T5, T6, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, arg6: T6) => Promise<TResult>,
): (
arg1: T1,
arg2: T2,
arg3: T3,
arg4: T4,
arg5: T5,
arg6: T6,
callback: (err: NodeJS.ErrnoException | null, result: TResult) => void,
) => void;
export interface CustomPromisifyLegacy<TCustom extends Function> extends Function {
__promisify__: TCustom;
}
export interface CustomPromisifySymbol<TCustom extends Function> extends Function {
[promisify.custom]: TCustom;
}
export type CustomPromisify<TCustom extends Function> =
| CustomPromisifySymbol<TCustom>
| CustomPromisifyLegacy<TCustom>;
/**
* Takes a function following the common error-first callback style, i.e. taking
* an `(err, value) => ...` callback as the last argument, and returns a version
* that returns promises.
*
* ```js
* const util = require('node:util');
* const fs = require('node:fs');
*
* const stat = util.promisify(fs.stat);
* stat('.').then((stats) => {
* // Do something with `stats`
* }).catch((error) => {
* // Handle the error.
* });
* ```
*
* Or, equivalently using `async function`s:
*
* ```js
* const util = require('node:util');
* const fs = require('node:fs');
*
* const stat = util.promisify(fs.stat);
*
* async function callStat() {
* const stats = await stat('.');
* console.log(`This directory is owned by ${stats.uid}`);
* }
*
* callStat();
* ```
*
* If there is an `original[util.promisify.custom]` property present, `promisify`will return its value, see `Custom promisified functions`.
*
* `promisify()` assumes that `original` is a function taking a callback as its
* final argument in all cases. If `original` is not a function, `promisify()`will throw an error. If `original` is a function but its last argument is not
* an error-first callback, it will still be passed an error-first
* callback as its last argument.
*
* Using `promisify()` on class methods or other methods that use `this` may not
* work as expected unless handled specially:
*
* ```js
* const util = require('node:util');
*
* class Foo {
* constructor() {
* this.a = 42;
* }
*
* bar(callback) {
* callback(null, this.a);
* }
* }
*
* const foo = new Foo();
*
* const naiveBar = util.promisify(foo.bar);
* // TypeError: Cannot read property 'a' of undefined
* // naiveBar().then(a => console.log(a));
*
* naiveBar.call(foo).then((a) => console.log(a)); // '42'
*
* const bindBar = naiveBar.bind(foo);
* bindBar().then((a) => console.log(a)); // '42'
* ```
* @since v8.0.0
*/
export function promisify<TCustom extends Function>(fn: CustomPromisify<TCustom>): TCustom;
export function promisify<TResult>(
fn: (callback: (err: any, result: TResult) => void) => void,
): () => Promise<TResult>;
export function promisify(fn: (callback: (err?: any) => void) => void): () => Promise<void>;
export function promisify<T1, TResult>(
fn: (arg1: T1, callback: (err: any, result: TResult) => void) => void,
): (arg1: T1) => Promise<TResult>;
export function promisify<T1>(fn: (arg1: T1, callback: (err?: any) => void) => void): (arg1: T1) => Promise<void>;
export function promisify<T1, T2, TResult>(
fn: (arg1: T1, arg2: T2, callback: (err: any, result: TResult) => void) => void,
): (arg1: T1, arg2: T2) => Promise<TResult>;
export function promisify<T1, T2>(
fn: (arg1: T1, arg2: T2, callback: (err?: any) => void) => void,
): (arg1: T1, arg2: T2) => Promise<void>;
export function promisify<T1, T2, T3, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err: any, result: TResult) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3) => Promise<TResult>;
export function promisify<T1, T2, T3>(
fn: (arg1: T1, arg2: T2, arg3: T3, callback: (err?: any) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3) => Promise<void>;
export function promisify<T1, T2, T3, T4, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err: any, result: TResult) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<TResult>;
export function promisify<T1, T2, T3, T4>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, callback: (err?: any) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4) => Promise<void>;
export function promisify<T1, T2, T3, T4, T5, TResult>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err: any, result: TResult) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<TResult>;
export function promisify<T1, T2, T3, T4, T5>(
fn: (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, callback: (err?: any) => void) => void,
): (arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5) => Promise<void>;
export function promisify(fn: Function): Function;
export namespace promisify {
/**
* That can be used to declare custom promisified variants of functions.
*/
const custom: unique symbol;
}
/**
* An implementation of the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) `TextDecoder` API.
*
* ```js
* const decoder = new TextDecoder();
* const u8arr = new Uint8Array([72, 101, 108, 108, 111]);
* console.log(decoder.decode(u8arr)); // Hello
* ```
* @since v8.3.0
*/
export class TextDecoder {
/**
* The encoding supported by the `TextDecoder` instance.
*/
readonly encoding: string;
/**
* The value will be `true` if decoding errors result in a `TypeError` being
* thrown.
*/
readonly fatal: boolean;
/**
* The value will be `true` if the decoding result will include the byte order
* mark.
*/
readonly ignoreBOM: boolean;
constructor(
encoding?: string,
options?: {
fatal?: boolean | undefined;
ignoreBOM?: boolean | undefined;
},
);
/**
* Decodes the `input` and returns a string. If `options.stream` is `true`, any
* incomplete byte sequences occurring at the end of the `input` are buffered
* internally and emitted after the next call to `textDecoder.decode()`.
*
* If `textDecoder.fatal` is `true`, decoding errors that occur will result in a`TypeError` being thrown.
* @param input An `ArrayBuffer`, `DataView`, or `TypedArray` instance containing the encoded data.
*/
decode(
input?: NodeJS.ArrayBufferView | ArrayBuffer | null,
options?: {
stream?: boolean | undefined;
},
): string;
}
export interface EncodeIntoResult {
/**
* The read Unicode code units of input.
*/
read: number;
/**
* The written UTF-8 bytes of output.
*/
written: number;
}
export { types };
//// TextEncoder/Decoder
/**
* An implementation of the [WHATWG Encoding Standard](https://encoding.spec.whatwg.org/) `TextEncoder` API. All
* instances of `TextEncoder` only support UTF-8 encoding.
*
* ```js
* const encoder = new TextEncoder();
* const uint8array = encoder.encode('this is some data');
* ```
*
* The `TextEncoder` class is also available on the global object.
* @since v8.3.0
*/
export class TextEncoder {
/**
* The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`.
*/
readonly encoding: string;
/**
* UTF-8 encodes the `input` string and returns a `Uint8Array` containing the
* encoded bytes.
* @param [input='an empty string'] The text to encode.
*/
encode(input?: string): Uint8Array;
/**
* UTF-8 encodes the `src` string to the `dest` Uint8Array and returns an object
* containing the read Unicode code units and written UTF-8 bytes.
*
* ```js
* const encoder = new TextEncoder();
* const src = 'this is some data';
* const dest = new Uint8Array(10);
* const { read, written } = encoder.encodeInto(src, dest);
* ```
* @param src The text to encode.
* @param dest The array to hold the encode result.
*/
encodeInto(src: string, dest: Uint8Array): EncodeIntoResult;
}
import { TextDecoder as _TextDecoder, TextEncoder as _TextEncoder } from "util";
global {
/**
* `TextDecoder` class is a global reference for `require('util').TextDecoder`
* https://nodejs.org/api/globals.html#textdecoder
* @since v11.0.0
*/
var TextDecoder: typeof globalThis extends {
onmessage: any;
TextDecoder: infer TextDecoder;
} ? TextDecoder
: typeof _TextDecoder;
/**
* `TextEncoder` class is a global reference for `require('util').TextEncoder`
* https://nodejs.org/api/globals.html#textencoder
* @since v11.0.0
*/
var TextEncoder: typeof globalThis extends {
onmessage: any;
TextEncoder: infer TextEncoder;
} ? TextEncoder
: typeof _TextEncoder;
}
//// parseArgs
/**
* Provides a higher level API for command-line argument parsing than interacting
* with `process.argv` directly. Takes a specification for the expected arguments
* and returns a structured object with the parsed options and positionals.
*
* ```js
* import { parseArgs } from 'node:util';
* const args = ['-f', '--bar', 'b'];
* const options = {
* foo: {
* type: 'boolean',
* short: 'f',
* },
* bar: {
* type: 'string',
* },
* };
* const {
* values,
* positionals,
* } = parseArgs({ args, options });
* console.log(values, positionals);
* // Prints: [Object: null prototype] { foo: true, bar: 'b' } []
* ```
* @since v18.3.0, v16.17.0
* @param config Used to provide arguments for parsing and to configure the parser. `config` supports the following properties:
* @return The parsed command line arguments:
*/
export function parseArgs<T extends ParseArgsConfig>(config?: T): ParsedResults<T>;
interface ParseArgsOptionConfig {
/**
* Type of argument.
*/
type: "string" | "boolean";
/**
* Whether this option can be provided multiple times.
* If `true`, all values will be collected in an array.
* If `false`, values for the option are last-wins.
* @default false.
*/
multiple?: boolean | undefined;
/**
* A single character alias for the option.
*/
short?: string | undefined;
/**
* The default option value when it is not set by args.
* It must be of the same type as the the `type` property.
* When `multiple` is `true`, it must be an array.
* @since v18.11.0
*/
default?: string | boolean | string[] | boolean[] | undefined;
}
interface ParseArgsOptionsConfig {
[longOption: string]: ParseArgsOptionConfig;
}
export interface ParseArgsConfig {
/**
* Array of argument strings.
*/
args?: string[] | undefined;
/**
* Used to describe arguments known to the parser.
*/
options?: ParseArgsOptionsConfig | undefined;
/**
* Should an error be thrown when unknown arguments are encountered,
* or when arguments are passed that do not match the `type` configured in `options`.
* @default true
*/
strict?: boolean | undefined;
/**
* Whether this command accepts positional arguments.
*/
allowPositionals?: boolean | undefined;
/**
* Return the parsed tokens. This is useful for extending the built-in behavior,
* from adding additional checks through to reprocessing the tokens in different ways.
* @default false
*/
tokens?: boolean | undefined;
}
/*
IfDefaultsTrue and IfDefaultsFalse are helpers to handle default values for missing boolean properties.
TypeScript does not have exact types for objects: https://github.com/microsoft/TypeScript/issues/12936
This means it is impossible to distinguish between "field X is definitely not present" and "field X may or may not be present".
But we expect users to generally provide their config inline or `as const`, which means TS will always know whether a given field is present.
So this helper treats "not definitely present" (i.e., not `extends boolean`) as being "definitely not present", i.e. it should have its default value.
This is technically incorrect but is a much nicer UX for the common case.
The IfDefaultsTrue version is for things which default to true; the IfDefaultsFalse version is for things which default to false.
*/
type IfDefaultsTrue<T, IfTrue, IfFalse> = T extends true ? IfTrue
: T extends false ? IfFalse
: IfTrue;
// we put the `extends false` condition first here because `undefined` compares like `any` when `strictNullChecks: false`
type IfDefaultsFalse<T, IfTrue, IfFalse> = T extends false ? IfFalse
: T extends true ? IfTrue
: IfFalse;
type ExtractOptionValue<T extends ParseArgsConfig, O extends ParseArgsOptionConfig> = IfDefaultsTrue<
T["strict"],
O["type"] extends "string" ? string : O["type"] extends "boolean" ? boolean : string | boolean,
string | boolean
>;
type ParsedValues<T extends ParseArgsConfig> =
& IfDefaultsTrue<T["strict"], unknown, { [longOption: string]: undefined | string | boolean }>
& (T["options"] extends ParseArgsOptionsConfig ? {
-readonly [LongOption in keyof T["options"]]: IfDefaultsFalse<
T["options"][LongOption]["multiple"],
undefined | Array<ExtractOptionValue<T, T["options"][LongOption]>>,
undefined | ExtractOptionValue<T, T["options"][LongOption]>
>;
}
: {});
type ParsedPositionals<T extends ParseArgsConfig> = IfDefaultsTrue<
T["strict"],
IfDefaultsFalse<T["allowPositionals"], string[], []>,
IfDefaultsTrue<T["allowPositionals"], string[], []>
>;
type PreciseTokenForOptions<
K extends string,
O extends ParseArgsOptionConfig,
> = O["type"] extends "string" ? {
kind: "option";
index: number;
name: K;
rawName: string;
value: string;
inlineValue: boolean;
}
: O["type"] extends "boolean" ? {
kind: "option";
index: number;
name: K;
rawName: string;
value: undefined;
inlineValue: undefined;
}
: OptionToken & { name: K };
type TokenForOptions<
T extends ParseArgsConfig,
K extends keyof T["options"] = keyof T["options"],
> = K extends unknown
? T["options"] extends ParseArgsOptionsConfig ? PreciseTokenForOptions<K & string, T["options"][K]>
: OptionToken
: never;
type ParsedOptionToken<T extends ParseArgsConfig> = IfDefaultsTrue<T["strict"], TokenForOptions<T>, OptionToken>;
type ParsedPositionalToken<T extends ParseArgsConfig> = IfDefaultsTrue<
T["strict"],
IfDefaultsFalse<T["allowPositionals"], { kind: "positional"; index: number; value: string }, never>,
IfDefaultsTrue<T["allowPositionals"], { kind: "positional"; index: number; value: string }, never>
>;
type ParsedTokens<T extends ParseArgsConfig> = Array<
ParsedOptionToken<T> | ParsedPositionalToken<T> | { kind: "option-terminator"; index: number }
>;
type PreciseParsedResults<T extends ParseArgsConfig> = IfDefaultsFalse<
T["tokens"],
{
values: ParsedValues<T>;
positionals: ParsedPositionals<T>;
tokens: ParsedTokens<T>;
},
{
values: ParsedValues<T>;
positionals: ParsedPositionals<T>;
}
>;
type OptionToken =
| { kind: "option"; index: number; name: string; rawName: string; value: string; inlineValue: boolean }
| {
kind: "option";
index: number;
name: string;
rawName: string;
value: undefined;
inlineValue: undefined;
};
type Token =
| OptionToken
| { kind: "positional"; index: number; value: string }
| { kind: "option-terminator"; index: number };
// If ParseArgsConfig extends T, then the user passed config constructed elsewhere.
// So we can't rely on the `"not definitely present" implies "definitely not present"` assumption mentioned above.
type ParsedResults<T extends ParseArgsConfig> = ParseArgsConfig extends T ? {
values: {
[longOption: string]: undefined | string | boolean | Array<string | boolean>;
};
positionals: string[];
tokens?: Token[];
}
: PreciseParsedResults<T>;
/**
* An implementation of [the MIMEType class](https://bmeck.github.io/node-proposal-mime-api/).
*
* In accordance with browser conventions, all properties of `MIMEType` objects
* are implemented as getters and setters on the class prototype, rather than as
* data properties on the object itself.
*
* A MIME string is a structured string containing multiple meaningful
* components. When parsed, a `MIMEType` object is returned containing
* properties for each of these components.
* @since v19.1.0, v18.13.0
* @experimental
*/
export class MIMEType {
/**
* Creates a new MIMEType object by parsing the input.
*
* A `TypeError` will be thrown if the `input` is not a valid MIME.
* Note that an effort will be made to coerce the given values into strings.
* @param input The input MIME to parse.
*/
constructor(input: string | { toString: () => string });
/**
* Gets and sets the type portion of the MIME.
*
* ```js
* import { MIMEType } from 'node:util';
*
* const myMIME = new MIMEType('text/javascript');
* console.log(myMIME.type);
* // Prints: text
* myMIME.type = 'application';
* console.log(myMIME.type);
* // Prints: application
* console.log(String(myMIME));
* // Prints: application/javascript
* ```
*/
type: string;
/**
* Gets and sets the subtype portion of the MIME.
*
* ```js
* import { MIMEType } from 'node:util';
*
* const myMIME = new MIMEType('text/ecmascript');
* console.log(myMIME.subtype);
* // Prints: ecmascript
* myMIME.subtype = 'javascript';
* console.log(myMIME.subtype);
* // Prints: javascript
* console.log(String(myMIME));
* // Prints: text/javascript
* ```
*/
subtype: string;
/**
* Gets the essence of the MIME. This property is read only.
* Use `mime.type` or `mime.subtype` to alter the MIME.
*
* ```js
* import { MIMEType } from 'node:util';
*
* const myMIME = new MIMEType('text/javascript;key=value');
* console.log(myMIME.essence);
* // Prints: text/javascript
* myMIME.type = 'application';
* console.log(myMIME.essence);
* // Prints: application/javascript
* console.log(String(myMIME));
* // Prints: application/javascript;key=value
* ```
*/
readonly essence: string;
/**
* Gets the `MIMEParams` object representing the
* parameters of the MIME. This property is read-only. See `MIMEParams` documentation for details.
*/
readonly params: MIMEParams;
/**
* The `toString()` method on the `MIMEType` object returns the serialized MIME.
*
* Because of the need for standard compliance, this method does not allow users
* to customize the serialization process of the MIME.
*/
toString(): string;
}
/**
* The `MIMEParams` API provides read and write access to the parameters of a`MIMEType`.
* @since v19.1.0, v18.13.0
*/
export class MIMEParams {
/**
* Remove all name-value pairs whose name is `name`.
*/
delete(name: string): void;
/**
* Returns an iterator over each of the name-value pairs in the parameters.
* Each item of the iterator is a JavaScript `Array`. The first item of the array
* is the `name`, the second item of the array is the `value`.
*/
entries(): IterableIterator<[string, string]>;
/**
* Returns the value of the first name-value pair whose name is `name`. If there
* are no such pairs, `null` is returned.
* @return or `null` if there is no name-value pair with the given `name`.
*/
get(name: string): string | null;
/**
* Returns `true` if there is at least one name-value pair whose name is `name`.
*/
has(name: string): boolean;
/**
* Returns an iterator over the names of each name-value pair.
*
* ```js
* import { MIMEType } from 'node:util';
*
* const { params } = new MIMEType('text/plain;foo=0;bar=1');
* for (const name of params.keys()) {
* console.log(name);
* }
* // Prints:
* // foo
* // bar
* ```
*/
keys(): IterableIterator<string>;
/**
* Sets the value in the `MIMEParams` object associated with `name` to`value`. If there are any pre-existing name-value pairs whose names are `name`,
* set the first such pair's value to `value`.
*
* ```js
* import { MIMEType } from 'node:util';
*
* const { params } = new MIMEType('text/plain;foo=0;bar=1');
* params.set('foo', 'def');
* params.set('baz', 'xyz');
* console.log(params.toString());
* // Prints: foo=def;bar=1;baz=xyz
* ```
*/
set(name: string, value: string): void;
/**
* Returns an iterator over the values of each name-value pair.
*/
values(): IterableIterator<string>;
/**
* Returns an iterator over each of the name-value pairs in the parameters.
*/
[Symbol.iterator]: typeof MIMEParams.prototype.entries;
}
}
declare module "util/types" {
import { KeyObject, webcrypto } from "node:crypto";
/**
* Returns `true` if the value is a built-in [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) or
* [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instance.
*
* See also `util.types.isArrayBuffer()` and `util.types.isSharedArrayBuffer()`.
*
* ```js
* util.types.isAnyArrayBuffer(new ArrayBuffer()); // Returns true
* util.types.isAnyArrayBuffer(new SharedArrayBuffer()); // Returns true
* ```
* @since v10.0.0
*/
function isAnyArrayBuffer(object: unknown): object is ArrayBufferLike;
/**
* Returns `true` if the value is an `arguments` object.
*
* ```js
* function foo() {
* util.types.isArgumentsObject(arguments); // Returns true
* }
* ```
* @since v10.0.0
*/
function isArgumentsObject(object: unknown): object is IArguments;
/**
* Returns `true` if the value is a built-in [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) instance.
* This does _not_ include [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instances. Usually, it is
* desirable to test for both; See `util.types.isAnyArrayBuffer()` for that.
*
* ```js
* util.types.isArrayBuffer(new ArrayBuffer()); // Returns true
* util.types.isArrayBuffer(new SharedArrayBuffer()); // Returns false
* ```
* @since v10.0.0
*/
function isArrayBuffer(object: unknown): object is ArrayBuffer;
/**
* Returns `true` if the value is an instance of one of the [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) views, such as typed
* array objects or [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView). Equivalent to
* [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView).
*
* ```js
* util.types.isArrayBufferView(new Int8Array()); // true
* util.types.isArrayBufferView(Buffer.from('hello world')); // true
* util.types.isArrayBufferView(new DataView(new ArrayBuffer(16))); // true
* util.types.isArrayBufferView(new ArrayBuffer()); // false
* ```
* @since v10.0.0
*/
function isArrayBufferView(object: unknown): object is NodeJS.ArrayBufferView;
/**
* Returns `true` if the value is an [async function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function).
* This only reports back what the JavaScript engine is seeing;
* in particular, the return value may not match the original source code if
* a transpilation tool was used.
*
* ```js
* util.types.isAsyncFunction(function foo() {}); // Returns false
* util.types.isAsyncFunction(async function foo() {}); // Returns true
* ```
* @since v10.0.0
*/
function isAsyncFunction(object: unknown): boolean;
/**
* Returns `true` if the value is a `BigInt64Array` instance.
*
* ```js
* util.types.isBigInt64Array(new BigInt64Array()); // Returns true
* util.types.isBigInt64Array(new BigUint64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isBigInt64Array(value: unknown): value is BigInt64Array;
/**
* Returns `true` if the value is a `BigUint64Array` instance.
*
* ```js
* util.types.isBigUint64Array(new BigInt64Array()); // Returns false
* util.types.isBigUint64Array(new BigUint64Array()); // Returns true
* ```
* @since v10.0.0
*/
function isBigUint64Array(value: unknown): value is BigUint64Array;
/**
* Returns `true` if the value is a boolean object, e.g. created
* by `new Boolean()`.
*
* ```js
* util.types.isBooleanObject(false); // Returns false
* util.types.isBooleanObject(true); // Returns false
* util.types.isBooleanObject(new Boolean(false)); // Returns true
* util.types.isBooleanObject(new Boolean(true)); // Returns true
* util.types.isBooleanObject(Boolean(false)); // Returns false
* util.types.isBooleanObject(Boolean(true)); // Returns false
* ```
* @since v10.0.0
*/
function isBooleanObject(object: unknown): object is Boolean;
/**
* Returns `true` if the value is any boxed primitive object, e.g. created
* by `new Boolean()`, `new String()` or `Object(Symbol())`.
*
* For example:
*
* ```js
* util.types.isBoxedPrimitive(false); // Returns false
* util.types.isBoxedPrimitive(new Boolean(false)); // Returns true
* util.types.isBoxedPrimitive(Symbol('foo')); // Returns false
* util.types.isBoxedPrimitive(Object(Symbol('foo'))); // Returns true
* util.types.isBoxedPrimitive(Object(BigInt(5))); // Returns true
* ```
* @since v10.11.0
*/
function isBoxedPrimitive(object: unknown): object is String | Number | BigInt | Boolean | Symbol;
/**
* Returns `true` if the value is a built-in [`DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) instance.
*
* ```js
* const ab = new ArrayBuffer(20);
* util.types.isDataView(new DataView(ab)); // Returns true
* util.types.isDataView(new Float64Array()); // Returns false
* ```
*
* See also [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView).
* @since v10.0.0
*/
function isDataView(object: unknown): object is DataView;
/**
* Returns `true` if the value is a built-in [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) instance.
*
* ```js
* util.types.isDate(new Date()); // Returns true
* ```
* @since v10.0.0
*/
function isDate(object: unknown): object is Date;
/**
* Returns `true` if the value is a native `External` value.
*
* A native `External` value is a special type of object that contains a
* raw C++ pointer (`void*`) for access from native code, and has no other
* properties. Such objects are created either by Node.js internals or native
* addons. In JavaScript, they are [frozen](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze) objects with a`null` prototype.
*
* ```c
* #include <js_native_api.h>
* #include <stdlib.h>
* napi_value result;
* static napi_value MyNapi(napi_env env, napi_callback_info info) {
* int* raw = (int*) malloc(1024);
* napi_status status = napi_create_external(env, (void*) raw, NULL, NULL, &result);
* if (status != napi_ok) {
* napi_throw_error(env, NULL, "napi_create_external failed");
* return NULL;
* }
* return result;
* }
* ...
* DECLARE_NAPI_PROPERTY("myNapi", MyNapi)
* ...
* ```
*
* ```js
* const native = require('napi_addon.node');
* const data = native.myNapi();
* util.types.isExternal(data); // returns true
* util.types.isExternal(0); // returns false
* util.types.isExternal(new String('foo')); // returns false
* ```
*
* For further information on `napi_create_external`, refer to `napi_create_external()`.
* @since v10.0.0
*/
function isExternal(object: unknown): boolean;
/**
* Returns `true` if the value is a built-in [`Float32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array) instance.
*
* ```js
* util.types.isFloat32Array(new ArrayBuffer()); // Returns false
* util.types.isFloat32Array(new Float32Array()); // Returns true
* util.types.isFloat32Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isFloat32Array(object: unknown): object is Float32Array;
/**
* Returns `true` if the value is a built-in [`Float64Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array) instance.
*
* ```js
* util.types.isFloat64Array(new ArrayBuffer()); // Returns false
* util.types.isFloat64Array(new Uint8Array()); // Returns false
* util.types.isFloat64Array(new Float64Array()); // Returns true
* ```
* @since v10.0.0
*/
function isFloat64Array(object: unknown): object is Float64Array;
/**
* Returns `true` if the value is a generator function.
* This only reports back what the JavaScript engine is seeing;
* in particular, the return value may not match the original source code if
* a transpilation tool was used.
*
* ```js
* util.types.isGeneratorFunction(function foo() {}); // Returns false
* util.types.isGeneratorFunction(function* foo() {}); // Returns true
* ```
* @since v10.0.0
*/
function isGeneratorFunction(object: unknown): object is GeneratorFunction;
/**
* Returns `true` if the value is a generator object as returned from a
* built-in generator function.
* This only reports back what the JavaScript engine is seeing;
* in particular, the return value may not match the original source code if
* a transpilation tool was used.
*
* ```js
* function* foo() {}
* const generator = foo();
* util.types.isGeneratorObject(generator); // Returns true
* ```
* @since v10.0.0
*/
function isGeneratorObject(object: unknown): object is Generator;
/**
* Returns `true` if the value is a built-in [`Int8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int8Array) instance.
*
* ```js
* util.types.isInt8Array(new ArrayBuffer()); // Returns false
* util.types.isInt8Array(new Int8Array()); // Returns true
* util.types.isInt8Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isInt8Array(object: unknown): object is Int8Array;
/**
* Returns `true` if the value is a built-in [`Int16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int16Array) instance.
*
* ```js
* util.types.isInt16Array(new ArrayBuffer()); // Returns false
* util.types.isInt16Array(new Int16Array()); // Returns true
* util.types.isInt16Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isInt16Array(object: unknown): object is Int16Array;
/**
* Returns `true` if the value is a built-in [`Int32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Int32Array) instance.
*
* ```js
* util.types.isInt32Array(new ArrayBuffer()); // Returns false
* util.types.isInt32Array(new Int32Array()); // Returns true
* util.types.isInt32Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isInt32Array(object: unknown): object is Int32Array;
/**
* Returns `true` if the value is a built-in [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance.
*
* ```js
* util.types.isMap(new Map()); // Returns true
* ```
* @since v10.0.0
*/
function isMap<T>(
object: T | {},
): object is T extends ReadonlyMap<any, any> ? (unknown extends T ? never : ReadonlyMap<any, any>)
: Map<unknown, unknown>;
/**
* Returns `true` if the value is an iterator returned for a built-in [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) instance.
*
* ```js
* const map = new Map();
* util.types.isMapIterator(map.keys()); // Returns true
* util.types.isMapIterator(map.values()); // Returns true
* util.types.isMapIterator(map.entries()); // Returns true
* util.types.isMapIterator(map[Symbol.iterator]()); // Returns true
* ```
* @since v10.0.0
*/
function isMapIterator(object: unknown): boolean;
/**
* Returns `true` if the value is an instance of a [Module Namespace Object](https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects).
*
* ```js
* import * as ns from './a.js';
*
* util.types.isModuleNamespaceObject(ns); // Returns true
* ```
* @since v10.0.0
*/
function isModuleNamespaceObject(value: unknown): boolean;
/**
* Returns `true` if the value was returned by the constructor of a [built-in `Error` type](https://tc39.es/ecma262/#sec-error-objects).
*
* ```js
* console.log(util.types.isNativeError(new Error())); // true
* console.log(util.types.isNativeError(new TypeError())); // true
* console.log(util.types.isNativeError(new RangeError())); // true
* ```
*
* Subclasses of the native error types are also native errors:
*
* ```js
* class MyError extends Error {}
* console.log(util.types.isNativeError(new MyError())); // true
* ```
*
* A value being `instanceof` a native error class is not equivalent to `isNativeError()`returning `true` for that value. `isNativeError()` returns `true` for errors
* which come from a different [realm](https://tc39.es/ecma262/#realm) while `instanceof Error` returns `false`for these errors:
*
* ```js
* const vm = require('node:vm');
* const context = vm.createContext({});
* const myError = vm.runInContext('new Error()', context);
* console.log(util.types.isNativeError(myError)); // true
* console.log(myError instanceof Error); // false
* ```
*
* Conversely, `isNativeError()` returns `false` for all objects which were not
* returned by the constructor of a native error. That includes values
* which are `instanceof` native errors:
*
* ```js
* const myError = { __proto__: Error.prototype };
* console.log(util.types.isNativeError(myError)); // false
* console.log(myError instanceof Error); // true
* ```
* @since v10.0.0
*/
function isNativeError(object: unknown): object is Error;
/**
* Returns `true` if the value is a number object, e.g. created
* by `new Number()`.
*
* ```js
* util.types.isNumberObject(0); // Returns false
* util.types.isNumberObject(new Number(0)); // Returns true
* ```
* @since v10.0.0
*/
function isNumberObject(object: unknown): object is Number;
/**
* Returns `true` if the value is a built-in [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise).
*
* ```js
* util.types.isPromise(Promise.resolve(42)); // Returns true
* ```
* @since v10.0.0
*/
function isPromise(object: unknown): object is Promise<unknown>;
/**
* Returns `true` if the value is a [`Proxy`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) instance.
*
* ```js
* const target = {};
* const proxy = new Proxy(target, {});
* util.types.isProxy(target); // Returns false
* util.types.isProxy(proxy); // Returns true
* ```
* @since v10.0.0
*/
function isProxy(object: unknown): boolean;
/**
* Returns `true` if the value is a regular expression object.
*
* ```js
* util.types.isRegExp(/abc/); // Returns true
* util.types.isRegExp(new RegExp('abc')); // Returns true
* ```
* @since v10.0.0
*/
function isRegExp(object: unknown): object is RegExp;
/**
* Returns `true` if the value is a built-in [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) instance.
*
* ```js
* util.types.isSet(new Set()); // Returns true
* ```
* @since v10.0.0
*/
function isSet<T>(
object: T | {},
): object is T extends ReadonlySet<any> ? (unknown extends T ? never : ReadonlySet<any>) : Set<unknown>;
/**
* Returns `true` if the value is an iterator returned for a built-in [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) instance.
*
* ```js
* const set = new Set();
* util.types.isSetIterator(set.keys()); // Returns true
* util.types.isSetIterator(set.values()); // Returns true
* util.types.isSetIterator(set.entries()); // Returns true
* util.types.isSetIterator(set[Symbol.iterator]()); // Returns true
* ```
* @since v10.0.0
*/
function isSetIterator(object: unknown): boolean;
/**
* Returns `true` if the value is a built-in [`SharedArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer) instance.
* This does _not_ include [`ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) instances. Usually, it is
* desirable to test for both; See `util.types.isAnyArrayBuffer()` for that.
*
* ```js
* util.types.isSharedArrayBuffer(new ArrayBuffer()); // Returns false
* util.types.isSharedArrayBuffer(new SharedArrayBuffer()); // Returns true
* ```
* @since v10.0.0
*/
function isSharedArrayBuffer(object: unknown): object is SharedArrayBuffer;
/**
* Returns `true` if the value is a string object, e.g. created
* by `new String()`.
*
* ```js
* util.types.isStringObject('foo'); // Returns false
* util.types.isStringObject(new String('foo')); // Returns true
* ```
* @since v10.0.0
*/
function isStringObject(object: unknown): object is String;
/**
* Returns `true` if the value is a symbol object, created
* by calling `Object()` on a `Symbol` primitive.
*
* ```js
* const symbol = Symbol('foo');
* util.types.isSymbolObject(symbol); // Returns false
* util.types.isSymbolObject(Object(symbol)); // Returns true
* ```
* @since v10.0.0
*/
function isSymbolObject(object: unknown): object is Symbol;
/**
* Returns `true` if the value is a built-in [`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) instance.
*
* ```js
* util.types.isTypedArray(new ArrayBuffer()); // Returns false
* util.types.isTypedArray(new Uint8Array()); // Returns true
* util.types.isTypedArray(new Float64Array()); // Returns true
* ```
*
* See also [`ArrayBuffer.isView()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/isView).
* @since v10.0.0
*/
function isTypedArray(object: unknown): object is NodeJS.TypedArray;
/**
* Returns `true` if the value is a built-in [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) instance.
*
* ```js
* util.types.isUint8Array(new ArrayBuffer()); // Returns false
* util.types.isUint8Array(new Uint8Array()); // Returns true
* util.types.isUint8Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isUint8Array(object: unknown): object is Uint8Array;
/**
* Returns `true` if the value is a built-in [`Uint8ClampedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8ClampedArray) instance.
*
* ```js
* util.types.isUint8ClampedArray(new ArrayBuffer()); // Returns false
* util.types.isUint8ClampedArray(new Uint8ClampedArray()); // Returns true
* util.types.isUint8ClampedArray(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isUint8ClampedArray(object: unknown): object is Uint8ClampedArray;
/**
* Returns `true` if the value is a built-in [`Uint16Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint16Array) instance.
*
* ```js
* util.types.isUint16Array(new ArrayBuffer()); // Returns false
* util.types.isUint16Array(new Uint16Array()); // Returns true
* util.types.isUint16Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isUint16Array(object: unknown): object is Uint16Array;
/**
* Returns `true` if the value is a built-in [`Uint32Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint32Array) instance.
*
* ```js
* util.types.isUint32Array(new ArrayBuffer()); // Returns false
* util.types.isUint32Array(new Uint32Array()); // Returns true
* util.types.isUint32Array(new Float64Array()); // Returns false
* ```
* @since v10.0.0
*/
function isUint32Array(object: unknown): object is Uint32Array;
/**
* Returns `true` if the value is a built-in [`WeakMap`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap) instance.
*
* ```js
* util.types.isWeakMap(new WeakMap()); // Returns true
* ```
* @since v10.0.0
*/
function isWeakMap(object: unknown): object is WeakMap<object, unknown>;
/**
* Returns `true` if the value is a built-in [`WeakSet`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet) instance.
*
* ```js
* util.types.isWeakSet(new WeakSet()); // Returns true
* ```
* @since v10.0.0
*/
function isWeakSet(object: unknown): object is WeakSet<object>;
/**
* Returns `true` if `value` is a `KeyObject`, `false` otherwise.
* @since v16.2.0
*/
function isKeyObject(object: unknown): object is KeyObject;
/**
* Returns `true` if `value` is a `CryptoKey`, `false` otherwise.
* @since v16.2.0
*/
function isCryptoKey(object: unknown): object is webcrypto.CryptoKey;
}
declare module "node:util" {
export * from "util";
}
declare module "node:util/types" {
export * from "util/types";
}
|