File size: 82,656 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 |
/**
* A stream is an abstract interface for working with streaming data in Node.js.
* The `node:stream` module provides an API for implementing the stream interface.
*
* There are many stream objects provided by Node.js. For instance, a `request to an HTTP server` and `process.stdout` are both stream instances.
*
* Streams can be readable, writable, or both. All streams are instances of `EventEmitter`.
*
* To access the `node:stream` module:
*
* ```js
* const stream = require('node:stream');
* ```
*
* The `node:stream` module is useful for creating new types of stream instances.
* It is usually not necessary to use the `node:stream` module to consume streams.
* @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/stream.js)
*/
declare module "stream" {
import { Abortable, EventEmitter } from "node:events";
import { Blob as NodeBlob } from "node:buffer";
import * as streamPromises from "node:stream/promises";
import * as streamConsumers from "node:stream/consumers";
import * as streamWeb from "node:stream/web";
type ComposeFnParam = (source: any) => void;
class internal extends EventEmitter {
pipe<T extends NodeJS.WritableStream>(
destination: T,
options?: {
end?: boolean | undefined;
},
): T;
compose<T extends NodeJS.ReadableStream>(
stream: T | ComposeFnParam | Iterable<T> | AsyncIterable<T>,
options?: { signal: AbortSignal },
): T;
}
import Stream = internal.Stream;
import Readable = internal.Readable;
import ReadableOptions = internal.ReadableOptions;
interface ArrayOptions {
/** the maximum concurrent invocations of `fn` to call on the stream at once. **Default: 1**. */
concurrency?: number;
/** allows destroying the stream if the signal is aborted. */
signal?: AbortSignal;
}
class ReadableBase extends Stream implements NodeJS.ReadableStream {
/**
* A utility method for creating Readable Streams out of iterators.
*/
static from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable;
/**
* Returns whether the stream has been read from or cancelled.
* @since v16.8.0
*/
static isDisturbed(stream: Readable | NodeJS.ReadableStream): boolean;
/**
* Returns whether the stream was destroyed or errored before emitting `'end'`.
* @since v16.8.0
* @experimental
*/
readonly readableAborted: boolean;
/**
* Is `true` if it is safe to call `readable.read()`, which means
* the stream has not been destroyed or emitted `'error'` or `'end'`.
* @since v11.4.0
*/
readable: boolean;
/**
* Returns whether `'data'` has been emitted.
* @since v16.7.0, v14.18.0
* @experimental
*/
readonly readableDidRead: boolean;
/**
* Getter for the property `encoding` of a given `Readable` stream. The `encoding`property can be set using the `readable.setEncoding()` method.
* @since v12.7.0
*/
readonly readableEncoding: BufferEncoding | null;
/**
* Becomes `true` when `'end'` event is emitted.
* @since v12.9.0
*/
readonly readableEnded: boolean;
/**
* This property reflects the current state of a `Readable` stream as described
* in the `Three states` section.
* @since v9.4.0
*/
readonly readableFlowing: boolean | null;
/**
* Returns the value of `highWaterMark` passed when creating this `Readable`.
* @since v9.3.0
*/
readonly readableHighWaterMark: number;
/**
* This property contains the number of bytes (or objects) in the queue
* ready to be read. The value provides introspection data regarding
* the status of the `highWaterMark`.
* @since v9.4.0
*/
readonly readableLength: number;
/**
* Getter for the property `objectMode` of a given `Readable` stream.
* @since v12.3.0
*/
readonly readableObjectMode: boolean;
/**
* Is `true` after `readable.destroy()` has been called.
* @since v8.0.0
*/
destroyed: boolean;
/**
* Is `true` after `'close'` has been emitted.
* @since v18.0.0
*/
readonly closed: boolean;
/**
* Returns error if the stream has been destroyed with an error.
* @since v18.0.0
*/
readonly errored: Error | null;
constructor(opts?: ReadableOptions);
_construct?(callback: (error?: Error | null) => void): void;
_read(size: number): void;
/**
* The `readable.read()` method reads data out of the internal buffer and
* returns it. If no data is available to be read, `null` is returned. By default,
* the data is returned as a `Buffer` object unless an encoding has been
* specified using the `readable.setEncoding()` method or the stream is operating
* in object mode.
*
* The optional `size` argument specifies a specific number of bytes to read. If`size` bytes are not available to be read, `null` will be returned _unless_the stream has ended, in which
* case all of the data remaining in the internal
* buffer will be returned.
*
* If the `size` argument is not specified, all of the data contained in the
* internal buffer will be returned.
*
* The `size` argument must be less than or equal to 1 GiB.
*
* The `readable.read()` method should only be called on `Readable` streams
* operating in paused mode. In flowing mode, `readable.read()` is called
* automatically until the internal buffer is fully drained.
*
* ```js
* const readable = getReadableStreamSomehow();
*
* // 'readable' may be triggered multiple times as data is buffered in
* readable.on('readable', () => {
* let chunk;
* console.log('Stream is readable (new data received in buffer)');
* // Use a loop to make sure we read all currently available data
* while (null !== (chunk = readable.read())) {
* console.log(`Read ${chunk.length} bytes of data...`);
* }
* });
*
* // 'end' will be triggered once when there is no more data available
* readable.on('end', () => {
* console.log('Reached end of stream.');
* });
* ```
*
* Each call to `readable.read()` returns a chunk of data, or `null`. The chunks
* are not concatenated. A `while` loop is necessary to consume all data
* currently in the buffer. When reading a large file `.read()` may return `null`,
* having consumed all buffered content so far, but there is still more data to
* come not yet buffered. In this case a new `'readable'` event will be emitted
* when there is more data in the buffer. Finally the `'end'` event will be
* emitted when there is no more data to come.
*
* Therefore to read a file's whole contents from a `readable`, it is necessary
* to collect chunks across multiple `'readable'` events:
*
* ```js
* const chunks = [];
*
* readable.on('readable', () => {
* let chunk;
* while (null !== (chunk = readable.read())) {
* chunks.push(chunk);
* }
* });
*
* readable.on('end', () => {
* const content = chunks.join('');
* });
* ```
*
* A `Readable` stream in object mode will always return a single item from
* a call to `readable.read(size)`, regardless of the value of the`size` argument.
*
* If the `readable.read()` method returns a chunk of data, a `'data'` event will
* also be emitted.
*
* Calling {@link read} after the `'end'` event has
* been emitted will return `null`. No runtime error will be raised.
* @since v0.9.4
* @param size Optional argument to specify how much data to read.
*/
read(size?: number): any;
/**
* The `readable.setEncoding()` method sets the character encoding for
* data read from the `Readable` stream.
*
* By default, no encoding is assigned and stream data will be returned as`Buffer` objects. Setting an encoding causes the stream data
* to be returned as strings of the specified encoding rather than as `Buffer`objects. For instance, calling `readable.setEncoding('utf8')` will cause the
* output data to be interpreted as UTF-8 data, and passed as strings. Calling`readable.setEncoding('hex')` will cause the data to be encoded in hexadecimal
* string format.
*
* The `Readable` stream will properly handle multi-byte characters delivered
* through the stream that would otherwise become improperly decoded if simply
* pulled from the stream as `Buffer` objects.
*
* ```js
* const readable = getReadableStreamSomehow();
* readable.setEncoding('utf8');
* readable.on('data', (chunk) => {
* assert.equal(typeof chunk, 'string');
* console.log('Got %d characters of string data:', chunk.length);
* });
* ```
* @since v0.9.4
* @param encoding The encoding to use.
*/
setEncoding(encoding: BufferEncoding): this;
/**
* The `readable.pause()` method will cause a stream in flowing mode to stop
* emitting `'data'` events, switching out of flowing mode. Any data that
* becomes available will remain in the internal buffer.
*
* ```js
* const readable = getReadableStreamSomehow();
* readable.on('data', (chunk) => {
* console.log(`Received ${chunk.length} bytes of data.`);
* readable.pause();
* console.log('There will be no additional data for 1 second.');
* setTimeout(() => {
* console.log('Now data will start flowing again.');
* readable.resume();
* }, 1000);
* });
* ```
*
* The `readable.pause()` method has no effect if there is a `'readable'`event listener.
* @since v0.9.4
*/
pause(): this;
/**
* The `readable.resume()` method causes an explicitly paused `Readable` stream to
* resume emitting `'data'` events, switching the stream into flowing mode.
*
* The `readable.resume()` method can be used to fully consume the data from a
* stream without actually processing any of that data:
*
* ```js
* getReadableStreamSomehow()
* .resume()
* .on('end', () => {
* console.log('Reached the end, but did not read anything.');
* });
* ```
*
* The `readable.resume()` method has no effect if there is a `'readable'`event listener.
* @since v0.9.4
*/
resume(): this;
/**
* The `readable.isPaused()` method returns the current operating state of the`Readable`. This is used primarily by the mechanism that underlies the`readable.pipe()` method. In most
* typical cases, there will be no reason to
* use this method directly.
*
* ```js
* const readable = new stream.Readable();
*
* readable.isPaused(); // === false
* readable.pause();
* readable.isPaused(); // === true
* readable.resume();
* readable.isPaused(); // === false
* ```
* @since v0.11.14
*/
isPaused(): boolean;
/**
* The `readable.unpipe()` method detaches a `Writable` stream previously attached
* using the {@link pipe} method.
*
* If the `destination` is not specified, then _all_ pipes are detached.
*
* If the `destination` is specified, but no pipe is set up for it, then
* the method does nothing.
*
* ```js
* const fs = require('node:fs');
* const readable = getReadableStreamSomehow();
* const writable = fs.createWriteStream('file.txt');
* // All the data from readable goes into 'file.txt',
* // but only for the first second.
* readable.pipe(writable);
* setTimeout(() => {
* console.log('Stop writing to file.txt.');
* readable.unpipe(writable);
* console.log('Manually close the file stream.');
* writable.end();
* }, 1000);
* ```
* @since v0.9.4
* @param destination Optional specific stream to unpipe
*/
unpipe(destination?: NodeJS.WritableStream): this;
/**
* Passing `chunk` as `null` signals the end of the stream (EOF) and behaves the
* same as `readable.push(null)`, after which no more data can be written. The EOF
* signal is put at the end of the buffer and any buffered data will still be
* flushed.
*
* The `readable.unshift()` method pushes a chunk of data back into the internal
* buffer. This is useful in certain situations where a stream is being consumed by
* code that needs to "un-consume" some amount of data that it has optimistically
* pulled out of the source, so that the data can be passed on to some other party.
*
* The `stream.unshift(chunk)` method cannot be called after the `'end'` event
* has been emitted or a runtime error will be thrown.
*
* Developers using `stream.unshift()` often should consider switching to
* use of a `Transform` stream instead. See the `API for stream implementers` section for more information.
*
* ```js
* // Pull off a header delimited by \n\n.
* // Use unshift() if we get too much.
* // Call the callback with (error, header, stream).
* const { StringDecoder } = require('node:string_decoder');
* function parseHeader(stream, callback) {
* stream.on('error', callback);
* stream.on('readable', onReadable);
* const decoder = new StringDecoder('utf8');
* let header = '';
* function onReadable() {
* let chunk;
* while (null !== (chunk = stream.read())) {
* const str = decoder.write(chunk);
* if (str.includes('\n\n')) {
* // Found the header boundary.
* const split = str.split(/\n\n/);
* header += split.shift();
* const remaining = split.join('\n\n');
* const buf = Buffer.from(remaining, 'utf8');
* stream.removeListener('error', callback);
* // Remove the 'readable' listener before unshifting.
* stream.removeListener('readable', onReadable);
* if (buf.length)
* stream.unshift(buf);
* // Now the body of the message can be read from the stream.
* callback(null, header, stream);
* return;
* }
* // Still reading the header.
* header += str;
* }
* }
* }
* ```
*
* Unlike {@link push}, `stream.unshift(chunk)` will not
* end the reading process by resetting the internal reading state of the stream.
* This can cause unexpected results if `readable.unshift()` is called during a
* read (i.e. from within a {@link _read} implementation on a
* custom stream). Following the call to `readable.unshift()` with an immediate {@link push} will reset the reading state appropriately,
* however it is best to simply avoid calling `readable.unshift()` while in the
* process of performing a read.
* @since v0.9.11
* @param chunk Chunk of data to unshift onto the read queue. For streams not operating in object mode, `chunk` must be a string, `Buffer`, `Uint8Array`, or `null`. For object mode
* streams, `chunk` may be any JavaScript value.
* @param encoding Encoding of string chunks. Must be a valid `Buffer` encoding, such as `'utf8'` or `'ascii'`.
*/
unshift(chunk: any, encoding?: BufferEncoding): void;
/**
* Prior to Node.js 0.10, streams did not implement the entire `node:stream`module API as it is currently defined. (See `Compatibility` for more
* information.)
*
* When using an older Node.js library that emits `'data'` events and has a {@link pause} method that is advisory only, the`readable.wrap()` method can be used to create a `Readable`
* stream that uses
* the old stream as its data source.
*
* It will rarely be necessary to use `readable.wrap()` but the method has been
* provided as a convenience for interacting with older Node.js applications and
* libraries.
*
* ```js
* const { OldReader } = require('./old-api-module.js');
* const { Readable } = require('node:stream');
* const oreader = new OldReader();
* const myReader = new Readable().wrap(oreader);
*
* myReader.on('readable', () => {
* myReader.read(); // etc.
* });
* ```
* @since v0.9.4
* @param stream An "old style" readable stream
*/
wrap(stream: NodeJS.ReadableStream): this;
push(chunk: any, encoding?: BufferEncoding): boolean;
/**
* The iterator created by this method gives users the option to cancel the destruction
* of the stream if the `for await...of` loop is exited by `return`, `break`, or `throw`,
* or if the iterator should destroy the stream if the stream emitted an error during iteration.
* @since v16.3.0
* @param options.destroyOnReturn When set to `false`, calling `return` on the async iterator,
* or exiting a `for await...of` iteration using a `break`, `return`, or `throw` will not destroy the stream.
* **Default: `true`**.
*/
iterator(options?: { destroyOnReturn?: boolean }): AsyncIterableIterator<any>;
/**
* This method allows mapping over the stream. The *fn* function will be called for every chunk in the stream.
* If the *fn* function returns a promise - that promise will be `await`ed before being passed to the result stream.
* @since v17.4.0, v16.14.0
* @param fn a function to map over every chunk in the stream. Async or not.
* @returns a stream mapped with the function *fn*.
*/
map(fn: (data: any, options?: Pick<ArrayOptions, "signal">) => any, options?: ArrayOptions): Readable;
/**
* This method allows filtering the stream. For each chunk in the stream the *fn* function will be called
* and if it returns a truthy value, the chunk will be passed to the result stream.
* If the *fn* function returns a promise - that promise will be `await`ed.
* @since v17.4.0, v16.14.0
* @param fn a function to filter chunks from the stream. Async or not.
* @returns a stream filtered with the predicate *fn*.
*/
filter(
fn: (data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>,
options?: ArrayOptions,
): Readable;
/**
* This method allows iterating a stream. For each chunk in the stream the *fn* function will be called.
* If the *fn* function returns a promise - that promise will be `await`ed.
*
* This method is different from `for await...of` loops in that it can optionally process chunks concurrently.
* In addition, a `forEach` iteration can only be stopped by having passed a `signal` option
* and aborting the related AbortController while `for await...of` can be stopped with `break` or `return`.
* In either case the stream will be destroyed.
*
* This method is different from listening to the `'data'` event in that it uses the `readable` event
* in the underlying machinary and can limit the number of concurrent *fn* calls.
* @since v17.5.0
* @param fn a function to call on each chunk of the stream. Async or not.
* @returns a promise for when the stream has finished.
*/
forEach(
fn: (data: any, options?: Pick<ArrayOptions, "signal">) => void | Promise<void>,
options?: ArrayOptions,
): Promise<void>;
/**
* This method allows easily obtaining the contents of a stream.
*
* As this method reads the entire stream into memory, it negates the benefits of streams. It's intended
* for interoperability and convenience, not as the primary way to consume streams.
* @since v17.5.0
* @returns a promise containing an array with the contents of the stream.
*/
toArray(options?: Pick<ArrayOptions, "signal">): Promise<any[]>;
/**
* This method is similar to `Array.prototype.some` and calls *fn* on each chunk in the stream
* until the awaited return value is `true` (or any truthy value). Once an *fn* call on a chunk
* `await`ed return value is truthy, the stream is destroyed and the promise is fulfilled with `true`.
* If none of the *fn* calls on the chunks return a truthy value, the promise is fulfilled with `false`.
* @since v17.5.0
* @param fn a function to call on each chunk of the stream. Async or not.
* @returns a promise evaluating to `true` if *fn* returned a truthy value for at least one of the chunks.
*/
some(
fn: (data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>,
options?: ArrayOptions,
): Promise<boolean>;
/**
* This method is similar to `Array.prototype.find` and calls *fn* on each chunk in the stream
* to find a chunk with a truthy value for *fn*. Once an *fn* call's awaited return value is truthy,
* the stream is destroyed and the promise is fulfilled with value for which *fn* returned a truthy value.
* If all of the *fn* calls on the chunks return a falsy value, the promise is fulfilled with `undefined`.
* @since v17.5.0
* @param fn a function to call on each chunk of the stream. Async or not.
* @returns a promise evaluating to the first chunk for which *fn* evaluated with a truthy value,
* or `undefined` if no element was found.
*/
find<T>(
fn: (data: any, options?: Pick<ArrayOptions, "signal">) => data is T,
options?: ArrayOptions,
): Promise<T | undefined>;
find(
fn: (data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>,
options?: ArrayOptions,
): Promise<any>;
/**
* This method is similar to `Array.prototype.every` and calls *fn* on each chunk in the stream
* to check if all awaited return values are truthy value for *fn*. Once an *fn* call on a chunk
* `await`ed return value is falsy, the stream is destroyed and the promise is fulfilled with `false`.
* If all of the *fn* calls on the chunks return a truthy value, the promise is fulfilled with `true`.
* @since v17.5.0
* @param fn a function to call on each chunk of the stream. Async or not.
* @returns a promise evaluating to `true` if *fn* returned a truthy value for every one of the chunks.
*/
every(
fn: (data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>,
options?: ArrayOptions,
): Promise<boolean>;
/**
* This method returns a new stream by applying the given callback to each chunk of the stream
* and then flattening the result.
*
* It is possible to return a stream or another iterable or async iterable from *fn* and the result streams
* will be merged (flattened) into the returned stream.
* @since v17.5.0
* @param fn a function to map over every chunk in the stream. May be async. May be a stream or generator.
* @returns a stream flat-mapped with the function *fn*.
*/
flatMap(fn: (data: any, options?: Pick<ArrayOptions, "signal">) => any, options?: ArrayOptions): Readable;
/**
* This method returns a new stream with the first *limit* chunks dropped from the start.
* @since v17.5.0
* @param limit the number of chunks to drop from the readable.
* @returns a stream with *limit* chunks dropped from the start.
*/
drop(limit: number, options?: Pick<ArrayOptions, "signal">): Readable;
/**
* This method returns a new stream with the first *limit* chunks.
* @since v17.5.0
* @param limit the number of chunks to take from the readable.
* @returns a stream with *limit* chunks taken.
*/
take(limit: number, options?: Pick<ArrayOptions, "signal">): Readable;
/**
* This method returns a new stream with chunks of the underlying stream paired with a counter
* in the form `[index, chunk]`. The first index value is `0` and it increases by 1 for each chunk produced.
* @since v17.5.0
* @returns a stream of indexed pairs.
*/
asIndexedPairs(options?: Pick<ArrayOptions, "signal">): Readable;
/**
* This method calls *fn* on each chunk of the stream in order, passing it the result from the calculation
* on the previous element. It returns a promise for the final value of the reduction.
*
* If no *initial* value is supplied the first chunk of the stream is used as the initial value.
* If the stream is empty, the promise is rejected with a `TypeError` with the `ERR_INVALID_ARGS` code property.
*
* The reducer function iterates the stream element-by-element which means that there is no *concurrency* parameter
* or parallelism. To perform a reduce concurrently, you can extract the async function to `readable.map` method.
* @since v17.5.0
* @param fn a reducer function to call over every chunk in the stream. Async or not.
* @param initial the initial value to use in the reduction.
* @returns a promise for the final value of the reduction.
*/
reduce<T = any>(
fn: (previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T,
initial?: undefined,
options?: Pick<ArrayOptions, "signal">,
): Promise<T>;
reduce<T = any>(
fn: (previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T,
initial: T,
options?: Pick<ArrayOptions, "signal">,
): Promise<T>;
_destroy(error: Error | null, callback: (error?: Error | null) => void): void;
/**
* Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the readable
* stream will release any internal resources and subsequent calls to `push()`will be ignored.
*
* Once `destroy()` has been called any further calls will be a no-op and no
* further errors except from `_destroy()` may be emitted as `'error'`.
*
* Implementors should not override this method, but instead implement `readable._destroy()`.
* @since v8.0.0
* @param error Error which will be passed as payload in `'error'` event
*/
destroy(error?: Error): this;
/**
* Event emitter
* The defined events on documents including:
* 1. close
* 2. data
* 3. end
* 4. error
* 5. pause
* 6. readable
* 7. resume
*/
addListener(event: "close", listener: () => void): this;
addListener(event: "data", listener: (chunk: any) => void): this;
addListener(event: "end", listener: () => void): this;
addListener(event: "error", listener: (err: Error) => void): this;
addListener(event: "pause", listener: () => void): this;
addListener(event: "readable", listener: () => void): this;
addListener(event: "resume", listener: () => void): this;
addListener(event: string | symbol, listener: (...args: any[]) => void): this;
emit(event: "close"): boolean;
emit(event: "data", chunk: any): boolean;
emit(event: "end"): boolean;
emit(event: "error", err: Error): boolean;
emit(event: "pause"): boolean;
emit(event: "readable"): boolean;
emit(event: "resume"): boolean;
emit(event: string | symbol, ...args: any[]): boolean;
on(event: "close", listener: () => void): this;
on(event: "data", listener: (chunk: any) => void): this;
on(event: "end", listener: () => void): this;
on(event: "error", listener: (err: Error) => void): this;
on(event: "pause", listener: () => void): this;
on(event: "readable", listener: () => void): this;
on(event: "resume", listener: () => void): this;
on(event: string | symbol, listener: (...args: any[]) => void): this;
once(event: "close", listener: () => void): this;
once(event: "data", listener: (chunk: any) => void): this;
once(event: "end", listener: () => void): this;
once(event: "error", listener: (err: Error) => void): this;
once(event: "pause", listener: () => void): this;
once(event: "readable", listener: () => void): this;
once(event: "resume", listener: () => void): this;
once(event: string | symbol, listener: (...args: any[]) => void): this;
prependListener(event: "close", listener: () => void): this;
prependListener(event: "data", listener: (chunk: any) => void): this;
prependListener(event: "end", listener: () => void): this;
prependListener(event: "error", listener: (err: Error) => void): this;
prependListener(event: "pause", listener: () => void): this;
prependListener(event: "readable", listener: () => void): this;
prependListener(event: "resume", listener: () => void): this;
prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
prependOnceListener(event: "close", listener: () => void): this;
prependOnceListener(event: "data", listener: (chunk: any) => void): this;
prependOnceListener(event: "end", listener: () => void): this;
prependOnceListener(event: "error", listener: (err: Error) => void): this;
prependOnceListener(event: "pause", listener: () => void): this;
prependOnceListener(event: "readable", listener: () => void): this;
prependOnceListener(event: "resume", listener: () => void): this;
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
removeListener(event: "close", listener: () => void): this;
removeListener(event: "data", listener: (chunk: any) => void): this;
removeListener(event: "end", listener: () => void): this;
removeListener(event: "error", listener: (err: Error) => void): this;
removeListener(event: "pause", listener: () => void): this;
removeListener(event: "readable", listener: () => void): this;
removeListener(event: "resume", listener: () => void): this;
removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
[Symbol.asyncIterator](): AsyncIterableIterator<any>;
/**
* Calls `readable.destroy()` with an `AbortError` and returns a promise that fulfills when the stream is finished.
* @since v20.4.0
*/
[Symbol.asyncDispose](): Promise<void>;
}
import WritableOptions = internal.WritableOptions;
class WritableBase extends Stream implements NodeJS.WritableStream {
/**
* Is `true` if it is safe to call `writable.write()`, which means
* the stream has not been destroyed, errored, or ended.
* @since v11.4.0
*/
readonly writable: boolean;
/**
* Is `true` after `writable.end()` has been called. This property
* does not indicate whether the data has been flushed, for this use `writable.writableFinished` instead.
* @since v12.9.0
*/
readonly writableEnded: boolean;
/**
* Is set to `true` immediately before the `'finish'` event is emitted.
* @since v12.6.0
*/
readonly writableFinished: boolean;
/**
* Return the value of `highWaterMark` passed when creating this `Writable`.
* @since v9.3.0
*/
readonly writableHighWaterMark: number;
/**
* This property contains the number of bytes (or objects) in the queue
* ready to be written. The value provides introspection data regarding
* the status of the `highWaterMark`.
* @since v9.4.0
*/
readonly writableLength: number;
/**
* Getter for the property `objectMode` of a given `Writable` stream.
* @since v12.3.0
*/
readonly writableObjectMode: boolean;
/**
* Number of times `writable.uncork()` needs to be
* called in order to fully uncork the stream.
* @since v13.2.0, v12.16.0
*/
readonly writableCorked: number;
/**
* Is `true` after `writable.destroy()` has been called.
* @since v8.0.0
*/
destroyed: boolean;
/**
* Is `true` after `'close'` has been emitted.
* @since v18.0.0
*/
readonly closed: boolean;
/**
* Returns error if the stream has been destroyed with an error.
* @since v18.0.0
*/
readonly errored: Error | null;
/**
* Is `true` if the stream's buffer has been full and stream will emit `'drain'`.
* @since v15.2.0, v14.17.0
*/
readonly writableNeedDrain: boolean;
constructor(opts?: WritableOptions);
_write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
_writev?(
chunks: Array<{
chunk: any;
encoding: BufferEncoding;
}>,
callback: (error?: Error | null) => void,
): void;
_construct?(callback: (error?: Error | null) => void): void;
_destroy(error: Error | null, callback: (error?: Error | null) => void): void;
_final(callback: (error?: Error | null) => void): void;
/**
* The `writable.write()` method writes some data to the stream, and calls the
* supplied `callback` once the data has been fully handled. If an error
* occurs, the `callback` will be called with the error as its
* first argument. The `callback` is called asynchronously and before `'error'` is
* emitted.
*
* The return value is `true` if the internal buffer is less than the`highWaterMark` configured when the stream was created after admitting `chunk`.
* If `false` is returned, further attempts to write data to the stream should
* stop until the `'drain'` event is emitted.
*
* While a stream is not draining, calls to `write()` will buffer `chunk`, and
* return false. Once all currently buffered chunks are drained (accepted for
* delivery by the operating system), the `'drain'` event will be emitted.
* Once `write()` returns false, do not write more chunks
* until the `'drain'` event is emitted. While calling `write()` on a stream that
* is not draining is allowed, Node.js will buffer all written chunks until
* maximum memory usage occurs, at which point it will abort unconditionally.
* Even before it aborts, high memory usage will cause poor garbage collector
* performance and high RSS (which is not typically released back to the system,
* even after the memory is no longer required). Since TCP sockets may never
* drain if the remote peer does not read the data, writing a socket that is
* not draining may lead to a remotely exploitable vulnerability.
*
* Writing data while the stream is not draining is particularly
* problematic for a `Transform`, because the `Transform` streams are paused
* by default until they are piped or a `'data'` or `'readable'` event handler
* is added.
*
* If the data to be written can be generated or fetched on demand, it is
* recommended to encapsulate the logic into a `Readable` and use {@link pipe}. However, if calling `write()` is preferred, it is
* possible to respect backpressure and avoid memory issues using the `'drain'` event:
*
* ```js
* function write(data, cb) {
* if (!stream.write(data)) {
* stream.once('drain', cb);
* } else {
* process.nextTick(cb);
* }
* }
*
* // Wait for cb to be called before doing any other write.
* write('hello', () => {
* console.log('Write completed, do more writes now.');
* });
* ```
*
* A `Writable` stream in object mode will always ignore the `encoding` argument.
* @since v0.9.4
* @param chunk Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any
* JavaScript value other than `null`.
* @param [encoding='utf8'] The encoding, if `chunk` is a string.
* @param callback Callback for when this chunk of data is flushed.
* @return `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; otherwise `true`.
*/
write(chunk: any, callback?: (error: Error | null | undefined) => void): boolean;
write(chunk: any, encoding: BufferEncoding, callback?: (error: Error | null | undefined) => void): boolean;
/**
* The `writable.setDefaultEncoding()` method sets the default `encoding` for a `Writable` stream.
* @since v0.11.15
* @param encoding The new default encoding
*/
setDefaultEncoding(encoding: BufferEncoding): this;
/**
* Calling the `writable.end()` method signals that no more data will be written
* to the `Writable`. The optional `chunk` and `encoding` arguments allow one
* final additional chunk of data to be written immediately before closing the
* stream.
*
* Calling the {@link write} method after calling {@link end} will raise an error.
*
* ```js
* // Write 'hello, ' and then end with 'world!'.
* const fs = require('node:fs');
* const file = fs.createWriteStream('example.txt');
* file.write('hello, ');
* file.end('world!');
* // Writing more now is not allowed!
* ```
* @since v0.9.4
* @param chunk Optional data to write. For streams not operating in object mode, `chunk` must be a string, `Buffer` or `Uint8Array`. For object mode streams, `chunk` may be any
* JavaScript value other than `null`.
* @param encoding The encoding if `chunk` is a string
* @param callback Callback for when the stream is finished.
*/
end(cb?: () => void): this;
end(chunk: any, cb?: () => void): this;
end(chunk: any, encoding: BufferEncoding, cb?: () => void): this;
/**
* The `writable.cork()` method forces all written data to be buffered in memory.
* The buffered data will be flushed when either the {@link uncork} or {@link end} methods are called.
*
* The primary intent of `writable.cork()` is to accommodate a situation in which
* several small chunks are written to the stream in rapid succession. Instead of
* immediately forwarding them to the underlying destination, `writable.cork()`buffers all the chunks until `writable.uncork()` is called, which will pass them
* all to `writable._writev()`, if present. This prevents a head-of-line blocking
* situation where data is being buffered while waiting for the first small chunk
* to be processed. However, use of `writable.cork()` without implementing`writable._writev()` may have an adverse effect on throughput.
*
* See also: `writable.uncork()`, `writable._writev()`.
* @since v0.11.2
*/
cork(): void;
/**
* The `writable.uncork()` method flushes all data buffered since {@link cork} was called.
*
* When using `writable.cork()` and `writable.uncork()` to manage the buffering
* of writes to a stream, defer calls to `writable.uncork()` using`process.nextTick()`. Doing so allows batching of all`writable.write()` calls that occur within a given Node.js event
* loop phase.
*
* ```js
* stream.cork();
* stream.write('some ');
* stream.write('data ');
* process.nextTick(() => stream.uncork());
* ```
*
* If the `writable.cork()` method is called multiple times on a stream, the
* same number of calls to `writable.uncork()` must be called to flush the buffered
* data.
*
* ```js
* stream.cork();
* stream.write('some ');
* stream.cork();
* stream.write('data ');
* process.nextTick(() => {
* stream.uncork();
* // The data will not be flushed until uncork() is called a second time.
* stream.uncork();
* });
* ```
*
* See also: `writable.cork()`.
* @since v0.11.2
*/
uncork(): void;
/**
* Destroy the stream. Optionally emit an `'error'` event, and emit a `'close'`event (unless `emitClose` is set to `false`). After this call, the writable
* stream has ended and subsequent calls to `write()` or `end()` will result in
* an `ERR_STREAM_DESTROYED` error.
* This is a destructive and immediate way to destroy a stream. Previous calls to`write()` may not have drained, and may trigger an `ERR_STREAM_DESTROYED` error.
* Use `end()` instead of destroy if data should flush before close, or wait for
* the `'drain'` event before destroying the stream.
*
* Once `destroy()` has been called any further calls will be a no-op and no
* further errors except from `_destroy()` may be emitted as `'error'`.
*
* Implementors should not override this method,
* but instead implement `writable._destroy()`.
* @since v8.0.0
* @param error Optional, an error to emit with `'error'` event.
*/
destroy(error?: Error): this;
/**
* Event emitter
* The defined events on documents including:
* 1. close
* 2. drain
* 3. error
* 4. finish
* 5. pipe
* 6. unpipe
*/
addListener(event: "close", listener: () => void): this;
addListener(event: "drain", listener: () => void): this;
addListener(event: "error", listener: (err: Error) => void): this;
addListener(event: "finish", listener: () => void): this;
addListener(event: "pipe", listener: (src: Readable) => void): this;
addListener(event: "unpipe", listener: (src: Readable) => void): this;
addListener(event: string | symbol, listener: (...args: any[]) => void): this;
emit(event: "close"): boolean;
emit(event: "drain"): boolean;
emit(event: "error", err: Error): boolean;
emit(event: "finish"): boolean;
emit(event: "pipe", src: Readable): boolean;
emit(event: "unpipe", src: Readable): boolean;
emit(event: string | symbol, ...args: any[]): boolean;
on(event: "close", listener: () => void): this;
on(event: "drain", listener: () => void): this;
on(event: "error", listener: (err: Error) => void): this;
on(event: "finish", listener: () => void): this;
on(event: "pipe", listener: (src: Readable) => void): this;
on(event: "unpipe", listener: (src: Readable) => void): this;
on(event: string | symbol, listener: (...args: any[]) => void): this;
once(event: "close", listener: () => void): this;
once(event: "drain", listener: () => void): this;
once(event: "error", listener: (err: Error) => void): this;
once(event: "finish", listener: () => void): this;
once(event: "pipe", listener: (src: Readable) => void): this;
once(event: "unpipe", listener: (src: Readable) => void): this;
once(event: string | symbol, listener: (...args: any[]) => void): this;
prependListener(event: "close", listener: () => void): this;
prependListener(event: "drain", listener: () => void): this;
prependListener(event: "error", listener: (err: Error) => void): this;
prependListener(event: "finish", listener: () => void): this;
prependListener(event: "pipe", listener: (src: Readable) => void): this;
prependListener(event: "unpipe", listener: (src: Readable) => void): this;
prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
prependOnceListener(event: "close", listener: () => void): this;
prependOnceListener(event: "drain", listener: () => void): this;
prependOnceListener(event: "error", listener: (err: Error) => void): this;
prependOnceListener(event: "finish", listener: () => void): this;
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this;
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this;
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
removeListener(event: "close", listener: () => void): this;
removeListener(event: "drain", listener: () => void): this;
removeListener(event: "error", listener: (err: Error) => void): this;
removeListener(event: "finish", listener: () => void): this;
removeListener(event: "pipe", listener: (src: Readable) => void): this;
removeListener(event: "unpipe", listener: (src: Readable) => void): this;
removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
}
namespace internal {
class Stream extends internal {
constructor(opts?: ReadableOptions);
}
interface StreamOptions<T extends Stream> extends Abortable {
emitClose?: boolean | undefined;
highWaterMark?: number | undefined;
objectMode?: boolean | undefined;
construct?(this: T, callback: (error?: Error | null) => void): void;
destroy?(this: T, error: Error | null, callback: (error?: Error | null) => void): void;
autoDestroy?: boolean | undefined;
}
interface ReadableOptions extends StreamOptions<Readable> {
encoding?: BufferEncoding | undefined;
read?(this: Readable, size: number): void;
}
/**
* @since v0.9.4
*/
class Readable extends ReadableBase {
/**
* A utility method for creating a `Readable` from a web `ReadableStream`.
* @since v17.0.0
* @experimental
*/
static fromWeb(
readableStream: streamWeb.ReadableStream,
options?: Pick<ReadableOptions, "encoding" | "highWaterMark" | "objectMode" | "signal">,
): Readable;
/**
* A utility method for creating a web `ReadableStream` from a `Readable`.
* @since v17.0.0
* @experimental
*/
static toWeb(streamReadable: Readable): streamWeb.ReadableStream;
}
interface WritableOptions extends StreamOptions<Writable> {
decodeStrings?: boolean | undefined;
defaultEncoding?: BufferEncoding | undefined;
write?(
this: Writable,
chunk: any,
encoding: BufferEncoding,
callback: (error?: Error | null) => void,
): void;
writev?(
this: Writable,
chunks: Array<{
chunk: any;
encoding: BufferEncoding;
}>,
callback: (error?: Error | null) => void,
): void;
final?(this: Writable, callback: (error?: Error | null) => void): void;
}
/**
* @since v0.9.4
*/
class Writable extends WritableBase {
/**
* A utility method for creating a `Writable` from a web `WritableStream`.
* @since v17.0.0
* @experimental
*/
static fromWeb(
writableStream: streamWeb.WritableStream,
options?: Pick<WritableOptions, "decodeStrings" | "highWaterMark" | "objectMode" | "signal">,
): Writable;
/**
* A utility method for creating a web `WritableStream` from a `Writable`.
* @since v17.0.0
* @experimental
*/
static toWeb(streamWritable: Writable): streamWeb.WritableStream;
}
interface DuplexOptions extends ReadableOptions, WritableOptions {
allowHalfOpen?: boolean | undefined;
readableObjectMode?: boolean | undefined;
writableObjectMode?: boolean | undefined;
readableHighWaterMark?: number | undefined;
writableHighWaterMark?: number | undefined;
writableCorked?: number | undefined;
construct?(this: Duplex, callback: (error?: Error | null) => void): void;
read?(this: Duplex, size: number): void;
write?(this: Duplex, chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
writev?(
this: Duplex,
chunks: Array<{
chunk: any;
encoding: BufferEncoding;
}>,
callback: (error?: Error | null) => void,
): void;
final?(this: Duplex, callback: (error?: Error | null) => void): void;
destroy?(this: Duplex, error: Error | null, callback: (error?: Error | null) => void): void;
}
/**
* Duplex streams are streams that implement both the `Readable` and `Writable` interfaces.
*
* Examples of `Duplex` streams include:
*
* * `TCP sockets`
* * `zlib streams`
* * `crypto streams`
* @since v0.9.4
*/
class Duplex extends ReadableBase implements WritableBase {
readonly writable: boolean;
readonly writableEnded: boolean;
readonly writableFinished: boolean;
readonly writableHighWaterMark: number;
readonly writableLength: number;
readonly writableObjectMode: boolean;
readonly writableCorked: number;
readonly writableNeedDrain: boolean;
readonly closed: boolean;
readonly errored: Error | null;
/**
* If `false` then the stream will automatically end the writable side when the
* readable side ends. Set initially by the `allowHalfOpen` constructor option,
* which defaults to `true`.
*
* This can be changed manually to change the half-open behavior of an existing`Duplex` stream instance, but must be changed before the `'end'` event is
* emitted.
* @since v0.9.4
*/
allowHalfOpen: boolean;
constructor(opts?: DuplexOptions);
/**
* A utility method for creating duplex streams.
*
* - `Stream` converts writable stream into writable `Duplex` and readable stream
* to `Duplex`.
* - `Blob` converts into readable `Duplex`.
* - `string` converts into readable `Duplex`.
* - `ArrayBuffer` converts into readable `Duplex`.
* - `AsyncIterable` converts into a readable `Duplex`. Cannot yield `null`.
* - `AsyncGeneratorFunction` converts into a readable/writable transform
* `Duplex`. Must take a source `AsyncIterable` as first parameter. Cannot yield
* `null`.
* - `AsyncFunction` converts into a writable `Duplex`. Must return
* either `null` or `undefined`
* - `Object ({ writable, readable })` converts `readable` and
* `writable` into `Stream` and then combines them into `Duplex` where the
* `Duplex` will write to the `writable` and read from the `readable`.
* - `Promise` converts into readable `Duplex`. Value `null` is ignored.
*
* @since v16.8.0
*/
static from(
src:
| Stream
| NodeBlob
| ArrayBuffer
| string
| Iterable<any>
| AsyncIterable<any>
| AsyncGeneratorFunction
| Promise<any>
| Object,
): Duplex;
_write(chunk: any, encoding: BufferEncoding, callback: (error?: Error | null) => void): void;
_writev?(
chunks: Array<{
chunk: any;
encoding: BufferEncoding;
}>,
callback: (error?: Error | null) => void,
): void;
_destroy(error: Error | null, callback: (error?: Error | null) => void): void;
_final(callback: (error?: Error | null) => void): void;
write(chunk: any, encoding?: BufferEncoding, cb?: (error: Error | null | undefined) => void): boolean;
write(chunk: any, cb?: (error: Error | null | undefined) => void): boolean;
setDefaultEncoding(encoding: BufferEncoding): this;
end(cb?: () => void): this;
end(chunk: any, cb?: () => void): this;
end(chunk: any, encoding?: BufferEncoding, cb?: () => void): this;
cork(): void;
uncork(): void;
/**
* A utility method for creating a web `ReadableStream` and `WritableStream` from a `Duplex`.
* @since v17.0.0
* @experimental
*/
static toWeb(streamDuplex: Duplex): {
readable: streamWeb.ReadableStream;
writable: streamWeb.WritableStream;
};
/**
* A utility method for creating a `Duplex` from a web `ReadableStream` and `WritableStream`.
* @since v17.0.0
* @experimental
*/
static fromWeb(
duplexStream: {
readable: streamWeb.ReadableStream;
writable: streamWeb.WritableStream;
},
options?: Pick<
DuplexOptions,
"allowHalfOpen" | "decodeStrings" | "encoding" | "highWaterMark" | "objectMode" | "signal"
>,
): Duplex;
/**
* Event emitter
* The defined events on documents including:
* 1. close
* 2. data
* 3. drain
* 4. end
* 5. error
* 6. finish
* 7. pause
* 8. pipe
* 9. readable
* 10. resume
* 11. unpipe
*/
addListener(event: "close", listener: () => void): this;
addListener(event: "data", listener: (chunk: any) => void): this;
addListener(event: "drain", listener: () => void): this;
addListener(event: "end", listener: () => void): this;
addListener(event: "error", listener: (err: Error) => void): this;
addListener(event: "finish", listener: () => void): this;
addListener(event: "pause", listener: () => void): this;
addListener(event: "pipe", listener: (src: Readable) => void): this;
addListener(event: "readable", listener: () => void): this;
addListener(event: "resume", listener: () => void): this;
addListener(event: "unpipe", listener: (src: Readable) => void): this;
addListener(event: string | symbol, listener: (...args: any[]) => void): this;
emit(event: "close"): boolean;
emit(event: "data", chunk: any): boolean;
emit(event: "drain"): boolean;
emit(event: "end"): boolean;
emit(event: "error", err: Error): boolean;
emit(event: "finish"): boolean;
emit(event: "pause"): boolean;
emit(event: "pipe", src: Readable): boolean;
emit(event: "readable"): boolean;
emit(event: "resume"): boolean;
emit(event: "unpipe", src: Readable): boolean;
emit(event: string | symbol, ...args: any[]): boolean;
on(event: "close", listener: () => void): this;
on(event: "data", listener: (chunk: any) => void): this;
on(event: "drain", listener: () => void): this;
on(event: "end", listener: () => void): this;
on(event: "error", listener: (err: Error) => void): this;
on(event: "finish", listener: () => void): this;
on(event: "pause", listener: () => void): this;
on(event: "pipe", listener: (src: Readable) => void): this;
on(event: "readable", listener: () => void): this;
on(event: "resume", listener: () => void): this;
on(event: "unpipe", listener: (src: Readable) => void): this;
on(event: string | symbol, listener: (...args: any[]) => void): this;
once(event: "close", listener: () => void): this;
once(event: "data", listener: (chunk: any) => void): this;
once(event: "drain", listener: () => void): this;
once(event: "end", listener: () => void): this;
once(event: "error", listener: (err: Error) => void): this;
once(event: "finish", listener: () => void): this;
once(event: "pause", listener: () => void): this;
once(event: "pipe", listener: (src: Readable) => void): this;
once(event: "readable", listener: () => void): this;
once(event: "resume", listener: () => void): this;
once(event: "unpipe", listener: (src: Readable) => void): this;
once(event: string | symbol, listener: (...args: any[]) => void): this;
prependListener(event: "close", listener: () => void): this;
prependListener(event: "data", listener: (chunk: any) => void): this;
prependListener(event: "drain", listener: () => void): this;
prependListener(event: "end", listener: () => void): this;
prependListener(event: "error", listener: (err: Error) => void): this;
prependListener(event: "finish", listener: () => void): this;
prependListener(event: "pause", listener: () => void): this;
prependListener(event: "pipe", listener: (src: Readable) => void): this;
prependListener(event: "readable", listener: () => void): this;
prependListener(event: "resume", listener: () => void): this;
prependListener(event: "unpipe", listener: (src: Readable) => void): this;
prependListener(event: string | symbol, listener: (...args: any[]) => void): this;
prependOnceListener(event: "close", listener: () => void): this;
prependOnceListener(event: "data", listener: (chunk: any) => void): this;
prependOnceListener(event: "drain", listener: () => void): this;
prependOnceListener(event: "end", listener: () => void): this;
prependOnceListener(event: "error", listener: (err: Error) => void): this;
prependOnceListener(event: "finish", listener: () => void): this;
prependOnceListener(event: "pause", listener: () => void): this;
prependOnceListener(event: "pipe", listener: (src: Readable) => void): this;
prependOnceListener(event: "readable", listener: () => void): this;
prependOnceListener(event: "resume", listener: () => void): this;
prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this;
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;
removeListener(event: "close", listener: () => void): this;
removeListener(event: "data", listener: (chunk: any) => void): this;
removeListener(event: "drain", listener: () => void): this;
removeListener(event: "end", listener: () => void): this;
removeListener(event: "error", listener: (err: Error) => void): this;
removeListener(event: "finish", listener: () => void): this;
removeListener(event: "pause", listener: () => void): this;
removeListener(event: "pipe", listener: (src: Readable) => void): this;
removeListener(event: "readable", listener: () => void): this;
removeListener(event: "resume", listener: () => void): this;
removeListener(event: "unpipe", listener: (src: Readable) => void): this;
removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
}
type TransformCallback = (error?: Error | null, data?: any) => void;
interface TransformOptions extends DuplexOptions {
construct?(this: Transform, callback: (error?: Error | null) => void): void;
read?(this: Transform, size: number): void;
write?(
this: Transform,
chunk: any,
encoding: BufferEncoding,
callback: (error?: Error | null) => void,
): void;
writev?(
this: Transform,
chunks: Array<{
chunk: any;
encoding: BufferEncoding;
}>,
callback: (error?: Error | null) => void,
): void;
final?(this: Transform, callback: (error?: Error | null) => void): void;
destroy?(this: Transform, error: Error | null, callback: (error?: Error | null) => void): void;
transform?(this: Transform, chunk: any, encoding: BufferEncoding, callback: TransformCallback): void;
flush?(this: Transform, callback: TransformCallback): void;
}
/**
* Transform streams are `Duplex` streams where the output is in some way
* related to the input. Like all `Duplex` streams, `Transform` streams
* implement both the `Readable` and `Writable` interfaces.
*
* Examples of `Transform` streams include:
*
* * `zlib streams`
* * `crypto streams`
* @since v0.9.4
*/
class Transform extends Duplex {
constructor(opts?: TransformOptions);
_transform(chunk: any, encoding: BufferEncoding, callback: TransformCallback): void;
_flush(callback: TransformCallback): void;
}
/**
* The `stream.PassThrough` class is a trivial implementation of a `Transform` stream that simply passes the input bytes across to the output. Its purpose is
* primarily for examples and testing, but there are some use cases where`stream.PassThrough` is useful as a building block for novel sorts of streams.
*/
class PassThrough extends Transform {}
/**
* A stream to attach a signal to.
*
* Attaches an AbortSignal to a readable or writeable stream. This lets code
* control stream destruction using an `AbortController`.
*
* Calling `abort` on the `AbortController` corresponding to the passed`AbortSignal` will behave the same way as calling `.destroy(new AbortError())`on the stream, and `controller.error(new
* AbortError())` for webstreams.
*
* ```js
* const fs = require('node:fs');
*
* const controller = new AbortController();
* const read = addAbortSignal(
* controller.signal,
* fs.createReadStream(('object.json')),
* );
* // Later, abort the operation closing the stream
* controller.abort();
* ```
*
* Or using an `AbortSignal` with a readable stream as an async iterable:
*
* ```js
* const controller = new AbortController();
* setTimeout(() => controller.abort(), 10_000); // set a timeout
* const stream = addAbortSignal(
* controller.signal,
* fs.createReadStream(('object.json')),
* );
* (async () => {
* try {
* for await (const chunk of stream) {
* await process(chunk);
* }
* } catch (e) {
* if (e.name === 'AbortError') {
* // The operation was cancelled
* } else {
* throw e;
* }
* }
* })();
* ```
*
* Or using an `AbortSignal` with a ReadableStream:
*
* ```js
* const controller = new AbortController();
* const rs = new ReadableStream({
* start(controller) {
* controller.enqueue('hello');
* controller.enqueue('world');
* controller.close();
* },
* });
*
* addAbortSignal(controller.signal, rs);
*
* finished(rs, (err) => {
* if (err) {
* if (err.name === 'AbortError') {
* // The operation was cancelled
* }
* }
* });
*
* const reader = rs.getReader();
*
* reader.read().then(({ value, done }) => {
* console.log(value); // hello
* console.log(done); // false
* controller.abort();
* });
* ```
* @since v15.4.0
* @param signal A signal representing possible cancellation
* @param stream a stream to attach a signal to
*/
function addAbortSignal<T extends Stream>(signal: AbortSignal, stream: T): T;
/**
* Returns the default highWaterMark used by streams.
* Defaults to `16384` (16 KiB), or `16` for `objectMode`.
* @since v19.9.0
* @param objectMode
*/
function getDefaultHighWaterMark(objectMode: boolean): number;
/**
* Sets the default highWaterMark used by streams.
* @since v19.9.0
* @param objectMode
* @param value highWaterMark value
*/
function setDefaultHighWaterMark(objectMode: boolean, value: number): void;
interface FinishedOptions extends Abortable {
error?: boolean | undefined;
readable?: boolean | undefined;
writable?: boolean | undefined;
}
/**
* A readable and/or writable stream/webstream.
*
* A function to get notified when a stream is no longer readable, writable
* or has experienced an error or a premature close event.
*
* ```js
* const { finished } = require('node:stream');
* const fs = require('node:fs');
*
* const rs = fs.createReadStream('archive.tar');
*
* finished(rs, (err) => {
* if (err) {
* console.error('Stream failed.', err);
* } else {
* console.log('Stream is done reading.');
* }
* });
*
* rs.resume(); // Drain the stream.
* ```
*
* Especially useful in error handling scenarios where a stream is destroyed
* prematurely (like an aborted HTTP request), and will not emit `'end'`or `'finish'`.
*
* The `finished` API provides `promise version`.
*
* `stream.finished()` leaves dangling event listeners (in particular`'error'`, `'end'`, `'finish'` and `'close'`) after `callback` has been
* invoked. The reason for this is so that unexpected `'error'` events (due to
* incorrect stream implementations) do not cause unexpected crashes.
* If this is unwanted behavior then the returned cleanup function needs to be
* invoked in the callback:
*
* ```js
* const cleanup = finished(rs, (err) => {
* cleanup();
* // ...
* });
* ```
* @since v10.0.0
* @param stream A readable and/or writable stream.
* @param callback A callback function that takes an optional error argument.
* @return A cleanup function which removes all registered listeners.
*/
function finished(
stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
options: FinishedOptions,
callback: (err?: NodeJS.ErrnoException | null) => void,
): () => void;
function finished(
stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
callback: (err?: NodeJS.ErrnoException | null) => void,
): () => void;
namespace finished {
function __promisify__(
stream: NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream,
options?: FinishedOptions,
): Promise<void>;
}
type PipelineSourceFunction<T> = () => Iterable<T> | AsyncIterable<T>;
type PipelineSource<T> = Iterable<T> | AsyncIterable<T> | NodeJS.ReadableStream | PipelineSourceFunction<T>;
type PipelineTransform<S extends PipelineTransformSource<any>, U> =
| NodeJS.ReadWriteStream
| ((
source: S extends (...args: any[]) => Iterable<infer ST> | AsyncIterable<infer ST> ? AsyncIterable<ST>
: S,
) => AsyncIterable<U>);
type PipelineTransformSource<T> = PipelineSource<T> | PipelineTransform<any, T>;
type PipelineDestinationIterableFunction<T> = (source: AsyncIterable<T>) => AsyncIterable<any>;
type PipelineDestinationPromiseFunction<T, P> = (source: AsyncIterable<T>) => Promise<P>;
type PipelineDestination<S extends PipelineTransformSource<any>, P> = S extends
PipelineTransformSource<infer ST> ?
| NodeJS.WritableStream
| PipelineDestinationIterableFunction<ST>
| PipelineDestinationPromiseFunction<ST, P>
: never;
type PipelineCallback<S extends PipelineDestination<any, any>> = S extends
PipelineDestinationPromiseFunction<any, infer P> ? (err: NodeJS.ErrnoException | null, value: P) => void
: (err: NodeJS.ErrnoException | null) => void;
type PipelinePromise<S extends PipelineDestination<any, any>> = S extends
PipelineDestinationPromiseFunction<any, infer P> ? Promise<P> : Promise<void>;
interface PipelineOptions {
signal?: AbortSignal | undefined;
end?: boolean | undefined;
}
/**
* A module method to pipe between streams and generators forwarding errors and
* properly cleaning up and provide a callback when the pipeline is complete.
*
* ```js
* const { pipeline } = require('node:stream');
* const fs = require('node:fs');
* const zlib = require('node:zlib');
*
* // Use the pipeline API to easily pipe a series of streams
* // together and get notified when the pipeline is fully done.
*
* // A pipeline to gzip a potentially huge tar file efficiently:
*
* pipeline(
* fs.createReadStream('archive.tar'),
* zlib.createGzip(),
* fs.createWriteStream('archive.tar.gz'),
* (err) => {
* if (err) {
* console.error('Pipeline failed.', err);
* } else {
* console.log('Pipeline succeeded.');
* }
* },
* );
* ```
*
* The `pipeline` API provides a `promise version`.
*
* `stream.pipeline()` will call `stream.destroy(err)` on all streams except:
*
* * `Readable` streams which have emitted `'end'` or `'close'`.
* * `Writable` streams which have emitted `'finish'` or `'close'`.
*
* `stream.pipeline()` leaves dangling event listeners on the streams
* after the `callback` has been invoked. In the case of reuse of streams after
* failure, this can cause event listener leaks and swallowed errors. If the last
* stream is readable, dangling event listeners will be removed so that the last
* stream can be consumed later.
*
* `stream.pipeline()` closes all the streams when an error is raised.
* The `IncomingRequest` usage with `pipeline` could lead to an unexpected behavior
* once it would destroy the socket without sending the expected response.
* See the example below:
*
* ```js
* const fs = require('node:fs');
* const http = require('node:http');
* const { pipeline } = require('node:stream');
*
* const server = http.createServer((req, res) => {
* const fileStream = fs.createReadStream('./fileNotExist.txt');
* pipeline(fileStream, res, (err) => {
* if (err) {
* console.log(err); // No such file
* // this message can't be sent once `pipeline` already destroyed the socket
* return res.end('error!!!');
* }
* });
* });
* ```
* @since v10.0.0
* @param callback Called when the pipeline is fully done.
*/
function pipeline<A extends PipelineSource<any>, B extends PipelineDestination<A, any>>(
source: A,
destination: B,
callback?: PipelineCallback<B>,
): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream;
function pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
B extends PipelineDestination<T1, any>,
>(
source: A,
transform1: T1,
destination: B,
callback?: PipelineCallback<B>,
): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream;
function pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
B extends PipelineDestination<T2, any>,
>(
source: A,
transform1: T1,
transform2: T2,
destination: B,
callback?: PipelineCallback<B>,
): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream;
function pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
T3 extends PipelineTransform<T2, any>,
B extends PipelineDestination<T3, any>,
>(
source: A,
transform1: T1,
transform2: T2,
transform3: T3,
destination: B,
callback?: PipelineCallback<B>,
): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream;
function pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
T3 extends PipelineTransform<T2, any>,
T4 extends PipelineTransform<T3, any>,
B extends PipelineDestination<T4, any>,
>(
source: A,
transform1: T1,
transform2: T2,
transform3: T3,
transform4: T4,
destination: B,
callback?: PipelineCallback<B>,
): B extends NodeJS.WritableStream ? B : NodeJS.WritableStream;
function pipeline(
streams: ReadonlyArray<NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream>,
callback?: (err: NodeJS.ErrnoException | null) => void,
): NodeJS.WritableStream;
function pipeline(
stream1: NodeJS.ReadableStream,
stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream,
...streams: Array<
NodeJS.ReadWriteStream | NodeJS.WritableStream | ((err: NodeJS.ErrnoException | null) => void)
>
): NodeJS.WritableStream;
namespace pipeline {
function __promisify__<A extends PipelineSource<any>, B extends PipelineDestination<A, any>>(
source: A,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>;
function __promisify__<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
B extends PipelineDestination<T1, any>,
>(
source: A,
transform1: T1,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>;
function __promisify__<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
B extends PipelineDestination<T2, any>,
>(
source: A,
transform1: T1,
transform2: T2,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>;
function __promisify__<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
T3 extends PipelineTransform<T2, any>,
B extends PipelineDestination<T3, any>,
>(
source: A,
transform1: T1,
transform2: T2,
transform3: T3,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>;
function __promisify__<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
T3 extends PipelineTransform<T2, any>,
T4 extends PipelineTransform<T3, any>,
B extends PipelineDestination<T4, any>,
>(
source: A,
transform1: T1,
transform2: T2,
transform3: T3,
transform4: T4,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>;
function __promisify__(
streams: ReadonlyArray<NodeJS.ReadableStream | NodeJS.WritableStream | NodeJS.ReadWriteStream>,
options?: PipelineOptions,
): Promise<void>;
function __promisify__(
stream1: NodeJS.ReadableStream,
stream2: NodeJS.ReadWriteStream | NodeJS.WritableStream,
...streams: Array<NodeJS.ReadWriteStream | NodeJS.WritableStream | PipelineOptions>
): Promise<void>;
}
interface Pipe {
close(): void;
hasRef(): boolean;
ref(): void;
unref(): void;
}
/**
* Returns whether the stream has encountered an error.
* @since v17.3.0, v16.14.0
* @experimental
*/
function isErrored(stream: Readable | Writable | NodeJS.ReadableStream | NodeJS.WritableStream): boolean;
/**
* Returns whether the stream is readable.
* @since v17.4.0, v16.14.0
* @experimental
*/
function isReadable(stream: Readable | NodeJS.ReadableStream): boolean;
const promises: typeof streamPromises;
const consumers: typeof streamConsumers;
}
export = internal;
}
declare module "node:stream" {
import stream = require("stream");
export = stream;
}
|