@types/node 16.4.12 → 16.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
node/buffer.d.ts CHANGED
@@ -6,10 +6,12 @@
6
6
  * extends it with methods that cover additional use cases. Node.js APIs accept
7
7
  * plain [`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)s wherever `Buffer`s are supported as well.
8
8
  *
9
- * The `Buffer` class is within the global scope, making it unlikely that one
10
- * would need to ever use `require('buffer').Buffer`.
9
+ * While the `Buffer` class is available within the global scope, it is still
10
+ * recommended to explicitly reference it via an import or require statement.
11
11
  *
12
12
  * ```js
13
+ * import { Buffer } from 'buffer';
14
+ *
13
15
  * // Creates a zero-filled Buffer of length 10.
14
16
  * const buf1 = Buffer.alloc(10);
15
17
  *
@@ -39,7 +41,7 @@
39
41
  * // Creates a Buffer containing the Latin-1 bytes [0x74, 0xe9, 0x73, 0x74].
40
42
  * const buf7 = Buffer.from('tést', 'latin1');
41
43
  * ```
42
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/buffer.js)
44
+ * @see [source](https://github.com/nodejs/node/blob/v16.6.0/lib/buffer.js)
43
45
  */
44
46
  declare module 'buffer' {
45
47
  import { BinaryLike } from 'node:crypto';
@@ -64,9 +66,9 @@ declare module 'buffer' {
64
66
  * sequence cannot be adequately represented in the target encoding. For instance:
65
67
  *
66
68
  * ```js
67
- * const buffer = require('buffer');
69
+ * import { Buffer, transcode } from 'buffer';
68
70
  *
69
- * const newBuf = buffer.transcode(Buffer.from('€'), 'utf8', 'ascii');
71
+ * const newBuf = transcode(Buffer.from('€'), 'utf8', 'ascii');
70
72
  * console.log(newBuf.toString('ascii'));
71
73
  * // Prints: '?'
72
74
  * ```
@@ -314,6 +316,8 @@ declare module 'buffer' {
314
316
  * written. However, partially encoded characters will not be written.
315
317
  *
316
318
  * ```js
319
+ * import { Buffer } from 'buffer';
320
+ *
317
321
  * const buf = Buffer.alloc(256);
318
322
  *
319
323
  * const len = buf.write('\u00bd + \u00bc = \u00be', 0);
@@ -348,6 +352,8 @@ declare module 'buffer' {
348
352
  * as {@link constants.MAX_STRING_LENGTH}.
349
353
  *
350
354
  * ```js
355
+ * import { Buffer } from 'buffer';
356
+ *
351
357
  * const buf1 = Buffer.allocUnsafe(26);
352
358
  *
353
359
  * for (let i = 0; i < 26; i++) {
@@ -383,6 +389,8 @@ declare module 'buffer' {
383
389
  * In particular, `Buffer.from(buf.toJSON())` works like `Buffer.from(buf)`.
384
390
  *
385
391
  * ```js
392
+ * import { Buffer } from 'buffer';
393
+ *
386
394
  * const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
387
395
  * const json = JSON.stringify(buf);
388
396
  *
@@ -408,6 +416,8 @@ declare module 'buffer' {
408
416
  * Returns `true` if both `buf` and `otherBuffer` have exactly the same bytes,`false` otherwise. Equivalent to `buf.compare(otherBuffer) === 0`.
409
417
  *
410
418
  * ```js
419
+ * import { Buffer } from 'buffer';
420
+ *
411
421
  * const buf1 = Buffer.from('ABC');
412
422
  * const buf2 = Buffer.from('414243', 'hex');
413
423
  * const buf3 = Buffer.from('ABCD');
@@ -430,6 +440,8 @@ declare module 'buffer' {
430
440
  * * `-1` is returned if `target` should come _after_`buf` when sorted.
431
441
  *
432
442
  * ```js
443
+ * import { Buffer } from 'buffer';
444
+ *
433
445
  * const buf1 = Buffer.from('ABC');
434
446
  * const buf2 = Buffer.from('BCD');
435
447
  * const buf3 = Buffer.from('ABCD');
@@ -452,6 +464,8 @@ declare module 'buffer' {
452
464
  * The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd`arguments can be used to limit the comparison to specific ranges within `target`and `buf` respectively.
453
465
  *
454
466
  * ```js
467
+ * import { Buffer } from 'buffer';
468
+ *
455
469
  * const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
456
470
  * const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);
457
471
  *
@@ -480,6 +494,8 @@ declare module 'buffer' {
480
494
  * different function arguments.
481
495
  *
482
496
  * ```js
497
+ * import { Buffer } from 'buffer';
498
+ *
483
499
  * // Create two `Buffer` instances.
484
500
  * const buf1 = Buffer.allocUnsafe(26);
485
501
  * const buf2 = Buffer.allocUnsafe(26).fill('!');
@@ -499,6 +515,8 @@ declare module 'buffer' {
499
515
  * ```
500
516
  *
501
517
  * ```js
518
+ * import { Buffer } from 'buffer';
519
+ *
502
520
  * // Create a `Buffer` and copy data from one region to an overlapping region
503
521
  * // within the same `Buffer`.
504
522
  *
@@ -532,6 +550,8 @@ declare module 'buffer' {
532
550
  * which is a superclass of `Buffer`. To copy the slice, use`Uint8Array.prototype.slice()`.
533
551
  *
534
552
  * ```js
553
+ * import { Buffer } from 'buffer';
554
+ *
535
555
  * const buf = Buffer.from('buffer');
536
556
  *
537
557
  * const copiedBuf = Uint8Array.prototype.slice.call(buf);
@@ -559,6 +579,8 @@ declare module 'buffer' {
559
579
  * Modifying the new `Buffer` slice will modify the memory in the original `Buffer`because the allocated memory of the two objects overlap.
560
580
  *
561
581
  * ```js
582
+ * import { Buffer } from 'buffer';
583
+ *
562
584
  * // Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
563
585
  * // from the original `Buffer`.
564
586
  *
@@ -584,6 +606,8 @@ declare module 'buffer' {
584
606
  * end of `buf` rather than the beginning.
585
607
  *
586
608
  * ```js
609
+ * import { Buffer } from 'buffer';
610
+ *
587
611
  * const buf = Buffer.from('buffer');
588
612
  *
589
613
  * console.log(buf.subarray(-6, -1).toString());
@@ -609,6 +633,8 @@ declare module 'buffer' {
609
633
  * `value` is interpreted and written as a two's complement signed integer.
610
634
  *
611
635
  * ```js
636
+ * import { Buffer } from 'buffer';
637
+ *
612
638
  * const buf = Buffer.allocUnsafe(8);
613
639
  *
614
640
  * buf.writeBigInt64BE(0x0102030405060708n, 0);
@@ -628,6 +654,8 @@ declare module 'buffer' {
628
654
  * `value` is interpreted and written as a two's complement signed integer.
629
655
  *
630
656
  * ```js
657
+ * import { Buffer } from 'buffer';
658
+ *
631
659
  * const buf = Buffer.allocUnsafe(8);
632
660
  *
633
661
  * buf.writeBigInt64LE(0x0102030405060708n, 0);
@@ -647,6 +675,8 @@ declare module 'buffer' {
647
675
  * This function is also available under the `writeBigUint64BE` alias.
648
676
  *
649
677
  * ```js
678
+ * import { Buffer } from 'buffer';
679
+ *
650
680
  * const buf = Buffer.allocUnsafe(8);
651
681
  *
652
682
  * buf.writeBigUInt64BE(0xdecafafecacefaden, 0);
@@ -664,6 +694,8 @@ declare module 'buffer' {
664
694
  * Writes `value` to `buf` at the specified `offset` as little-endian
665
695
  *
666
696
  * ```js
697
+ * import { Buffer } from 'buffer';
698
+ *
667
699
  * const buf = Buffer.allocUnsafe(8);
668
700
  *
669
701
  * buf.writeBigUInt64LE(0xdecafafecacefaden, 0);
@@ -686,6 +718,8 @@ declare module 'buffer' {
686
718
  * This function is also available under the `writeUintLE` alias.
687
719
  *
688
720
  * ```js
721
+ * import { Buffer } from 'buffer';
722
+ *
689
723
  * const buf = Buffer.allocUnsafe(6);
690
724
  *
691
725
  * buf.writeUIntLE(0x1234567890ab, 0, 6);
@@ -707,6 +741,8 @@ declare module 'buffer' {
707
741
  * This function is also available under the `writeUintBE` alias.
708
742
  *
709
743
  * ```js
744
+ * import { Buffer } from 'buffer';
745
+ *
710
746
  * const buf = Buffer.allocUnsafe(6);
711
747
  *
712
748
  * buf.writeUIntBE(0x1234567890ab, 0, 6);
@@ -726,6 +762,8 @@ declare module 'buffer' {
726
762
  * when `value` is anything other than a signed integer.
727
763
  *
728
764
  * ```js
765
+ * import { Buffer } from 'buffer';
766
+ *
729
767
  * const buf = Buffer.allocUnsafe(6);
730
768
  *
731
769
  * buf.writeIntLE(0x1234567890ab, 0, 6);
@@ -745,6 +783,8 @@ declare module 'buffer' {
745
783
  * signed integer.
746
784
  *
747
785
  * ```js
786
+ * import { Buffer } from 'buffer';
787
+ *
748
788
  * const buf = Buffer.allocUnsafe(6);
749
789
  *
750
790
  * buf.writeIntBE(0x1234567890ab, 0, 6);
@@ -765,6 +805,8 @@ declare module 'buffer' {
765
805
  * This function is also available under the `readBigUint64BE` alias.
766
806
  *
767
807
  * ```js
808
+ * import { Buffer } from 'buffer';
809
+ *
768
810
  * const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
769
811
  *
770
812
  * console.log(buf.readBigUInt64BE(0));
@@ -780,6 +822,8 @@ declare module 'buffer' {
780
822
  * This function is also available under the `readBigUint64LE` alias.
781
823
  *
782
824
  * ```js
825
+ * import { Buffer } from 'buffer';
826
+ *
783
827
  * const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);
784
828
  *
785
829
  * console.log(buf.readBigUInt64LE(0));
@@ -814,6 +858,8 @@ declare module 'buffer' {
814
858
  * This function is also available under the `readUintLE` alias.
815
859
  *
816
860
  * ```js
861
+ * import { Buffer } from 'buffer';
862
+ *
817
863
  * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
818
864
  *
819
865
  * console.log(buf.readUIntLE(0, 6).toString(16));
@@ -831,6 +877,8 @@ declare module 'buffer' {
831
877
  * This function is also available under the `readUintBE` alias.
832
878
  *
833
879
  * ```js
880
+ * import { Buffer } from 'buffer';
881
+ *
834
882
  * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
835
883
  *
836
884
  * console.log(buf.readUIntBE(0, 6).toString(16));
@@ -848,6 +896,8 @@ declare module 'buffer' {
848
896
  * supporting up to 48 bits of accuracy.
849
897
  *
850
898
  * ```js
899
+ * import { Buffer } from 'buffer';
900
+ *
851
901
  * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
852
902
  *
853
903
  * console.log(buf.readIntLE(0, 6).toString(16));
@@ -863,6 +913,8 @@ declare module 'buffer' {
863
913
  * supporting up to 48 bits of accuracy.
864
914
  *
865
915
  * ```js
916
+ * import { Buffer } from 'buffer';
917
+ *
866
918
  * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);
867
919
  *
868
920
  * console.log(buf.readIntBE(0, 6).toString(16));
@@ -883,6 +935,8 @@ declare module 'buffer' {
883
935
  * This function is also available under the `readUint8` alias.
884
936
  *
885
937
  * ```js
938
+ * import { Buffer } from 'buffer';
939
+ *
886
940
  * const buf = Buffer.from([1, -2]);
887
941
  *
888
942
  * console.log(buf.readUInt8(0));
@@ -902,6 +956,8 @@ declare module 'buffer' {
902
956
  * This function is also available under the `readUint16LE` alias.
903
957
  *
904
958
  * ```js
959
+ * import { Buffer } from 'buffer';
960
+ *
905
961
  * const buf = Buffer.from([0x12, 0x34, 0x56]);
906
962
  *
907
963
  * console.log(buf.readUInt16LE(0).toString(16));
@@ -921,6 +977,8 @@ declare module 'buffer' {
921
977
  * This function is also available under the `readUint16BE` alias.
922
978
  *
923
979
  * ```js
980
+ * import { Buffer } from 'buffer';
981
+ *
924
982
  * const buf = Buffer.from([0x12, 0x34, 0x56]);
925
983
  *
926
984
  * console.log(buf.readUInt16BE(0).toString(16));
@@ -938,6 +996,8 @@ declare module 'buffer' {
938
996
  * This function is also available under the `readUint32LE` alias.
939
997
  *
940
998
  * ```js
999
+ * import { Buffer } from 'buffer';
1000
+ *
941
1001
  * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
942
1002
  *
943
1003
  * console.log(buf.readUInt32LE(0).toString(16));
@@ -955,6 +1015,8 @@ declare module 'buffer' {
955
1015
  * This function is also available under the `readUint32BE` alias.
956
1016
  *
957
1017
  * ```js
1018
+ * import { Buffer } from 'buffer';
1019
+ *
958
1020
  * const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);
959
1021
  *
960
1022
  * console.log(buf.readUInt32BE(0).toString(16));
@@ -970,6 +1032,8 @@ declare module 'buffer' {
970
1032
  * Integers read from a `Buffer` are interpreted as two's complement signed values.
971
1033
  *
972
1034
  * ```js
1035
+ * import { Buffer } from 'buffer';
1036
+ *
973
1037
  * const buf = Buffer.from([-1, 5]);
974
1038
  *
975
1039
  * console.log(buf.readInt8(0));
@@ -989,6 +1053,8 @@ declare module 'buffer' {
989
1053
  * Integers read from a `Buffer` are interpreted as two's complement signed values.
990
1054
  *
991
1055
  * ```js
1056
+ * import { Buffer } from 'buffer';
1057
+ *
992
1058
  * const buf = Buffer.from([0, 5]);
993
1059
  *
994
1060
  * console.log(buf.readInt16LE(0));
@@ -1006,6 +1072,8 @@ declare module 'buffer' {
1006
1072
  * Integers read from a `Buffer` are interpreted as two's complement signed values.
1007
1073
  *
1008
1074
  * ```js
1075
+ * import { Buffer } from 'buffer';
1076
+ *
1009
1077
  * const buf = Buffer.from([0, 5]);
1010
1078
  *
1011
1079
  * console.log(buf.readInt16BE(0));
@@ -1021,6 +1089,8 @@ declare module 'buffer' {
1021
1089
  * Integers read from a `Buffer` are interpreted as two's complement signed values.
1022
1090
  *
1023
1091
  * ```js
1092
+ * import { Buffer } from 'buffer';
1093
+ *
1024
1094
  * const buf = Buffer.from([0, 0, 0, 5]);
1025
1095
  *
1026
1096
  * console.log(buf.readInt32LE(0));
@@ -1038,6 +1108,8 @@ declare module 'buffer' {
1038
1108
  * Integers read from a `Buffer` are interpreted as two's complement signed values.
1039
1109
  *
1040
1110
  * ```js
1111
+ * import { Buffer } from 'buffer';
1112
+ *
1041
1113
  * const buf = Buffer.from([0, 0, 0, 5]);
1042
1114
  *
1043
1115
  * console.log(buf.readInt32BE(0));
@@ -1051,6 +1123,8 @@ declare module 'buffer' {
1051
1123
  * Reads a 32-bit, little-endian float from `buf` at the specified `offset`.
1052
1124
  *
1053
1125
  * ```js
1126
+ * import { Buffer } from 'buffer';
1127
+ *
1054
1128
  * const buf = Buffer.from([1, 2, 3, 4]);
1055
1129
  *
1056
1130
  * console.log(buf.readFloatLE(0));
@@ -1066,6 +1140,8 @@ declare module 'buffer' {
1066
1140
  * Reads a 32-bit, big-endian float from `buf` at the specified `offset`.
1067
1141
  *
1068
1142
  * ```js
1143
+ * import { Buffer } from 'buffer';
1144
+ *
1069
1145
  * const buf = Buffer.from([1, 2, 3, 4]);
1070
1146
  *
1071
1147
  * console.log(buf.readFloatBE(0));
@@ -1079,6 +1155,8 @@ declare module 'buffer' {
1079
1155
  * Reads a 64-bit, little-endian double from `buf` at the specified `offset`.
1080
1156
  *
1081
1157
  * ```js
1158
+ * import { Buffer } from 'buffer';
1159
+ *
1082
1160
  * const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
1083
1161
  *
1084
1162
  * console.log(buf.readDoubleLE(0));
@@ -1094,6 +1172,8 @@ declare module 'buffer' {
1094
1172
  * Reads a 64-bit, big-endian double from `buf` at the specified `offset`.
1095
1173
  *
1096
1174
  * ```js
1175
+ * import { Buffer } from 'buffer';
1176
+ *
1097
1177
  * const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);
1098
1178
  *
1099
1179
  * console.log(buf.readDoubleBE(0));
@@ -1109,6 +1189,8 @@ declare module 'buffer' {
1109
1189
  * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 2.
1110
1190
  *
1111
1191
  * ```js
1192
+ * import { Buffer } from 'buffer';
1193
+ *
1112
1194
  * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
1113
1195
  *
1114
1196
  * console.log(buf1);
@@ -1129,6 +1211,8 @@ declare module 'buffer' {
1129
1211
  * between UTF-16 little-endian and UTF-16 big-endian:
1130
1212
  *
1131
1213
  * ```js
1214
+ * import { Buffer } from 'buffer';
1215
+ *
1132
1216
  * const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
1133
1217
  * buf.swap16(); // Convert to big-endian UTF-16 text.
1134
1218
  * ```
@@ -1141,6 +1225,8 @@ declare module 'buffer' {
1141
1225
  * byte order _in-place_. Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 4.
1142
1226
  *
1143
1227
  * ```js
1228
+ * import { Buffer } from 'buffer';
1229
+ *
1144
1230
  * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
1145
1231
  *
1146
1232
  * console.log(buf1);
@@ -1165,6 +1251,8 @@ declare module 'buffer' {
1165
1251
  * Throws `ERR_INVALID_BUFFER_SIZE` if `buf.length` is not a multiple of 8.
1166
1252
  *
1167
1253
  * ```js
1254
+ * import { Buffer } from 'buffer';
1255
+ *
1168
1256
  * const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);
1169
1257
  *
1170
1258
  * console.log(buf1);
@@ -1192,6 +1280,8 @@ declare module 'buffer' {
1192
1280
  * This function is also available under the `writeUint8` alias.
1193
1281
  *
1194
1282
  * ```js
1283
+ * import { Buffer } from 'buffer';
1284
+ *
1195
1285
  * const buf = Buffer.allocUnsafe(4);
1196
1286
  *
1197
1287
  * buf.writeUInt8(0x3, 0);
@@ -1215,6 +1305,8 @@ declare module 'buffer' {
1215
1305
  * This function is also available under the `writeUint16LE` alias.
1216
1306
  *
1217
1307
  * ```js
1308
+ * import { Buffer } from 'buffer';
1309
+ *
1218
1310
  * const buf = Buffer.allocUnsafe(4);
1219
1311
  *
1220
1312
  * buf.writeUInt16LE(0xdead, 0);
@@ -1236,6 +1328,8 @@ declare module 'buffer' {
1236
1328
  * This function is also available under the `writeUint16BE` alias.
1237
1329
  *
1238
1330
  * ```js
1331
+ * import { Buffer } from 'buffer';
1332
+ *
1239
1333
  * const buf = Buffer.allocUnsafe(4);
1240
1334
  *
1241
1335
  * buf.writeUInt16BE(0xdead, 0);
@@ -1257,6 +1351,8 @@ declare module 'buffer' {
1257
1351
  * This function is also available under the `writeUint32LE` alias.
1258
1352
  *
1259
1353
  * ```js
1354
+ * import { Buffer } from 'buffer';
1355
+ *
1260
1356
  * const buf = Buffer.allocUnsafe(4);
1261
1357
  *
1262
1358
  * buf.writeUInt32LE(0xfeedface, 0);
@@ -1277,6 +1373,8 @@ declare module 'buffer' {
1277
1373
  * This function is also available under the `writeUint32BE` alias.
1278
1374
  *
1279
1375
  * ```js
1376
+ * import { Buffer } from 'buffer';
1377
+ *
1280
1378
  * const buf = Buffer.allocUnsafe(4);
1281
1379
  *
1282
1380
  * buf.writeUInt32BE(0xfeedface, 0);
@@ -1298,6 +1396,8 @@ declare module 'buffer' {
1298
1396
  * `value` is interpreted and written as a two's complement signed integer.
1299
1397
  *
1300
1398
  * ```js
1399
+ * import { Buffer } from 'buffer';
1400
+ *
1301
1401
  * const buf = Buffer.allocUnsafe(2);
1302
1402
  *
1303
1403
  * buf.writeInt8(2, 0);
@@ -1319,6 +1419,8 @@ declare module 'buffer' {
1319
1419
  * The `value` is interpreted and written as a two's complement signed integer.
1320
1420
  *
1321
1421
  * ```js
1422
+ * import { Buffer } from 'buffer';
1423
+ *
1322
1424
  * const buf = Buffer.allocUnsafe(2);
1323
1425
  *
1324
1426
  * buf.writeInt16LE(0x0304, 0);
@@ -1339,6 +1441,8 @@ declare module 'buffer' {
1339
1441
  * The `value` is interpreted and written as a two's complement signed integer.
1340
1442
  *
1341
1443
  * ```js
1444
+ * import { Buffer } from 'buffer';
1445
+ *
1342
1446
  * const buf = Buffer.allocUnsafe(2);
1343
1447
  *
1344
1448
  * buf.writeInt16BE(0x0102, 0);
@@ -1359,6 +1463,8 @@ declare module 'buffer' {
1359
1463
  * The `value` is interpreted and written as a two's complement signed integer.
1360
1464
  *
1361
1465
  * ```js
1466
+ * import { Buffer } from 'buffer';
1467
+ *
1362
1468
  * const buf = Buffer.allocUnsafe(4);
1363
1469
  *
1364
1470
  * buf.writeInt32LE(0x05060708, 0);
@@ -1379,6 +1485,8 @@ declare module 'buffer' {
1379
1485
  * The `value` is interpreted and written as a two's complement signed integer.
1380
1486
  *
1381
1487
  * ```js
1488
+ * import { Buffer } from 'buffer';
1489
+ *
1382
1490
  * const buf = Buffer.allocUnsafe(4);
1383
1491
  *
1384
1492
  * buf.writeInt32BE(0x01020304, 0);
@@ -1397,6 +1505,8 @@ declare module 'buffer' {
1397
1505
  * undefined when `value` is anything other than a JavaScript number.
1398
1506
  *
1399
1507
  * ```js
1508
+ * import { Buffer } from 'buffer';
1509
+ *
1400
1510
  * const buf = Buffer.allocUnsafe(4);
1401
1511
  *
1402
1512
  * buf.writeFloatLE(0xcafebabe, 0);
@@ -1415,6 +1525,8 @@ declare module 'buffer' {
1415
1525
  * undefined when `value` is anything other than a JavaScript number.
1416
1526
  *
1417
1527
  * ```js
1528
+ * import { Buffer } from 'buffer';
1529
+ *
1418
1530
  * const buf = Buffer.allocUnsafe(4);
1419
1531
  *
1420
1532
  * buf.writeFloatBE(0xcafebabe, 0);
@@ -1433,6 +1545,8 @@ declare module 'buffer' {
1433
1545
  * other than a JavaScript number.
1434
1546
  *
1435
1547
  * ```js
1548
+ * import { Buffer } from 'buffer';
1549
+ *
1436
1550
  * const buf = Buffer.allocUnsafe(8);
1437
1551
  *
1438
1552
  * buf.writeDoubleLE(123.456, 0);
@@ -1451,6 +1565,8 @@ declare module 'buffer' {
1451
1565
  * other than a JavaScript number.
1452
1566
  *
1453
1567
  * ```js
1568
+ * import { Buffer } from 'buffer';
1569
+ *
1454
1570
  * const buf = Buffer.allocUnsafe(8);
1455
1571
  *
1456
1572
  * buf.writeDoubleBE(123.456, 0);
@@ -1469,6 +1585,8 @@ declare module 'buffer' {
1469
1585
  * the entire `buf` will be filled:
1470
1586
  *
1471
1587
  * ```js
1588
+ * import { Buffer } from 'buffer';
1589
+ *
1472
1590
  * // Fill a `Buffer` with the ASCII character 'h'.
1473
1591
  *
1474
1592
  * const b = Buffer.allocUnsafe(50).fill('h');
@@ -1485,6 +1603,8 @@ declare module 'buffer' {
1485
1603
  * then only the bytes of that character that fit into `buf` are written:
1486
1604
  *
1487
1605
  * ```js
1606
+ * import { Buffer } from 'buffer';
1607
+ *
1488
1608
  * // Fill a `Buffer` with character that takes up two bytes in UTF-8.
1489
1609
  *
1490
1610
  * console.log(Buffer.allocUnsafe(5).fill('\u0222'));
@@ -1495,6 +1615,8 @@ declare module 'buffer' {
1495
1615
  * fill data remains, an exception is thrown:
1496
1616
  *
1497
1617
  * ```js
1618
+ * import { Buffer } from 'buffer';
1619
+ *
1498
1620
  * const buf = Buffer.allocUnsafe(5);
1499
1621
  *
1500
1622
  * console.log(buf.fill('a'));
@@ -1522,6 +1644,8 @@ declare module 'buffer' {
1522
1644
  * value between `0` and `255`.
1523
1645
  *
1524
1646
  * ```js
1647
+ * import { Buffer } from 'buffer';
1648
+ *
1525
1649
  * const buf = Buffer.from('this is a buffer');
1526
1650
  *
1527
1651
  * console.log(buf.indexOf('this'));
@@ -1553,6 +1677,8 @@ declare module 'buffer' {
1553
1677
  * behavior matches [`String.prototype.indexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf).
1554
1678
  *
1555
1679
  * ```js
1680
+ * import { Buffer } from 'buffer';
1681
+ *
1556
1682
  * const b = Buffer.from('abcdef');
1557
1683
  *
1558
1684
  * // Passing a value that's a number, but not a valid byte.
@@ -1582,6 +1708,8 @@ declare module 'buffer' {
1582
1708
  * rather than the first occurrence.
1583
1709
  *
1584
1710
  * ```js
1711
+ * import { Buffer } from 'buffer';
1712
+ *
1585
1713
  * const buf = Buffer.from('this buffer is a buffer');
1586
1714
  *
1587
1715
  * console.log(buf.lastIndexOf('this'));
@@ -1615,6 +1743,8 @@ declare module 'buffer' {
1615
1743
  * This behavior matches [`String.prototype.lastIndexOf()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf).
1616
1744
  *
1617
1745
  * ```js
1746
+ * import { Buffer } from 'buffer';
1747
+ *
1618
1748
  * const b = Buffer.from('abcdef');
1619
1749
  *
1620
1750
  * // Passing a value that's a number, but not a valid byte.
@@ -1646,6 +1776,8 @@ declare module 'buffer' {
1646
1776
  * of `buf`.
1647
1777
  *
1648
1778
  * ```js
1779
+ * import { Buffer } from 'buffer';
1780
+ *
1649
1781
  * // Log the entire contents of a `Buffer`.
1650
1782
  *
1651
1783
  * const buf = Buffer.from('buffer');
@@ -1668,6 +1800,8 @@ declare module 'buffer' {
1668
1800
  * Equivalent to `buf.indexOf() !== -1`.
1669
1801
  *
1670
1802
  * ```js
1803
+ * import { Buffer } from 'buffer';
1804
+ *
1671
1805
  * const buf = Buffer.from('this is a buffer');
1672
1806
  *
1673
1807
  * console.log(buf.includes('this'));
@@ -1696,6 +1830,8 @@ declare module 'buffer' {
1696
1830
  * Creates and returns an [iterator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) of `buf` keys (indices).
1697
1831
  *
1698
1832
  * ```js
1833
+ * import { Buffer } from 'buffer';
1834
+ *
1699
1835
  * const buf = Buffer.from('buffer');
1700
1836
  *
1701
1837
  * for (const key of buf.keys()) {
@@ -1717,6 +1853,8 @@ declare module 'buffer' {
1717
1853
  * called automatically when a `Buffer` is used in a `for..of` statement.
1718
1854
  *
1719
1855
  * ```js
1856
+ * import { Buffer } from 'buffer';
1857
+ *
1720
1858
  * const buf = Buffer.from('buffer');
1721
1859
  *
1722
1860
  * for (const value of buf.values()) {
node/child_process.d.ts CHANGED
@@ -60,7 +60,7 @@
60
60
  * For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however,
61
61
  * the synchronous methods can have significant impact on performance due to
62
62
  * stalling the event loop while spawned processes complete.
63
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/child_process.js)
63
+ * @see [source](https://github.com/nodejs/node/blob/v16.6.0/lib/child_process.js)
64
64
  */
65
65
  declare module 'child_process' {
66
66
  import { ObjectEncodingOptions } from 'node:fs';
node/cluster.d.ts CHANGED
@@ -7,9 +7,12 @@
7
7
  * server ports.
8
8
  *
9
9
  * ```js
10
- * const cluster = require('cluster');
11
- * const http = require('http');
12
- * const numCPUs = require('os').cpus().length;
10
+ * import cluster from 'cluster';
11
+ * import http from 'http';
12
+ * import { cpus } from 'os';
13
+ * import process from 'process';
14
+ *
15
+ * const numCPUs = cpus().length;
13
16
  *
14
17
  * if (cluster.isPrimary) {
15
18
  * console.log(`Primary ${process.pid} is running`);
@@ -46,7 +49,7 @@
46
49
  * ```
47
50
  *
48
51
  * On Windows, it is not yet possible to set up a named pipe server in a worker.
49
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/cluster.js)
52
+ * @see [source](https://github.com/nodejs/node/blob/v16.6.0/lib/cluster.js)
50
53
  */
51
54
  declare module 'cluster' {
52
55
  import * as child from 'node:child_process';
@@ -215,9 +218,12 @@ declare module 'cluster' {
215
218
  * because of exiting or being signaled). Otherwise, it returns `false`.
216
219
  *
217
220
  * ```js
218
- * const cluster = require('cluster');
219
- * const http = require('http');
220
- * const numCPUs = require('os').cpus().length;
221
+ * import cluster from 'cluster';
222
+ * import http from 'http';
223
+ * import { cpus } from 'os';
224
+ * import process from 'process';
225
+ *
226
+ * const numCPUs = cpus().length;
221
227
  *
222
228
  * if (cluster.isPrimary) {
223
229
  * console.log(`Primary ${process.pid} is running`);
@@ -322,7 +328,7 @@ declare module 'cluster' {
322
328
  export interface Cluster extends EventEmitter {
323
329
  disconnect(callback?: () => void): void;
324
330
  fork(env?: any): Worker;
325
- /** @deprecated since v16.0.0 - use setupPrimary. */
331
+ /** @deprecated since v16.0.0 - use isPrimary. */
326
332
  readonly isMaster: boolean;
327
333
  readonly isPrimary: boolean;
328
334
  readonly isWorker: boolean;
node/console.d.ts CHANGED
@@ -53,7 +53,7 @@
53
53
  * myConsole.warn(`Danger ${name}! Danger!`);
54
54
  * // Prints: Danger Will Robinson! Danger!, to err
55
55
  * ```
56
- * @see [source](https://github.com/nodejs/node/blob/v16.4.2/lib/console.js)
56
+ * @see [source](https://github.com/nodejs/node/blob/v16.6.0/lib/console.js)
57
57
  */
58
58
  declare module 'console' {
59
59
  import console = require('node:console');