Packages

trait Buffer extends Object with StObject with Uint8Array with _KeyLike with _PathLike

Annotations
@JSType() @native()
Linear Supertypes
_PathLike, _KeyLike, Uint8Array, NumberDictionary[Double], StObject, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Buffer
  2. _PathLike
  3. _KeyLike
  4. Uint8Array
  5. NumberDictionary
  6. StObject
  7. Object
  8. Any
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val BYTES_PER_ELEMENT: Double

    The size in bytes of each element in the array.

    The size in bytes of each element in the array.

    Definition Classes
    Uint8Array
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val buffer: ArrayBuffer

    The ArrayBuffer instance referenced by the array.

    The ArrayBuffer instance referenced by the array.

    Definition Classes
    Uint8Array
  7. val byteLength: Double

    The length in bytes of the array.

    The length in bytes of the array.

    Definition Classes
    Uint8Array
  8. val byteOffset: Double

    The offset in bytes of the array.

    The offset in bytes of the array.

    Definition Classes
    Uint8Array
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Unit, sourceStart: Unit, sourceEnd: Double): Double
  11. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Unit, sourceStart: Double, sourceEnd: Double): Double
  12. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Unit, sourceStart: Double): Double
  13. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double, sourceStart: Unit, sourceEnd: Double): Double
  14. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double, sourceStart: Double, sourceEnd: Double): Double
  15. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double, sourceStart: Double): Double
  16. def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double): Double
  17. def compare(target: Uint8Array, targetStart: Double, targetEnd: Unit, sourceStart: Unit, sourceEnd: Double): Double
  18. def compare(target: Uint8Array, targetStart: Double, targetEnd: Unit, sourceStart: Double, sourceEnd: Double): Double
  19. def compare(target: Uint8Array, targetStart: Double, targetEnd: Unit, sourceStart: Double): Double
  20. def compare(target: Uint8Array, targetStart: Double, targetEnd: Double, sourceStart: Unit, sourceEnd: Double): Double
  21. def compare(target: Uint8Array, targetStart: Double, targetEnd: Double, sourceStart: Double, sourceEnd: Double): Double
  22. def compare(target: Uint8Array, targetStart: Double, targetEnd: Double, sourceStart: Double): Double
  23. def compare(target: Uint8Array, targetStart: Double, targetEnd: Double): Double
  24. def compare(target: Uint8Array, targetStart: Double): Double
  25. def compare(target: Uint8Array): Double

    Compares buf with target and returns a number indicating whether bufcomes before, after, or is the same as target in sort order.

    Compares buf with target and returns a number indicating whether bufcomes before, after, or is the same as target in sort order. Comparison is based on the actual sequence of bytes in each Buffer.

    * 0 is returned if target is the same as buf * 1 is returned if target should come _before_buf when sorted. * -1 is returned if target should come _after_buf when sorted.

    js import { Buffer } from 'buffer';

    const buf1 = Buffer.from('ABC'); const buf2 = Buffer.from('BCD'); const buf3 = Buffer.from('ABCD');

    console.log(buf1.compare(buf1)); // Prints: 0 console.log(buf1.compare(buf2)); // Prints: -1 console.log(buf1.compare(buf3)); // Prints: -1 console.log(buf2.compare(buf1)); // Prints: 1 console.log(buf2.compare(buf3)); // Prints: 1 console.log([buf1, buf2, buf3].sort(Buffer.compare)); // Prints: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ] // (This result is equal to: [buf1, buf3, buf2].)

    The optional targetStart, targetEnd, sourceStart, and sourceEndarguments can be used to limit the comparison to specific ranges within targetand buf respectively.

    js import { Buffer } from 'buffer';

    const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]); const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

    console.log(buf1.compare(buf2, 5, 9, 0, 4)); // Prints: 0 console.log(buf1.compare(buf2, 0, 6, 4)); // Prints: -1 console.log(buf1.compare(buf2, 5, 6, 5)); // Prints: 1

    ERR_OUT_OF_RANGE is thrown if targetStart < 0, sourceStart < 0,targetEnd > target.byteLength, or sourceEnd > source.byteLength.

    target

    A Buffer or Uint8Array with which to compare buf.

    Since

    v0.11.13

  26. def copy(target: Uint8Array, targetStart: Unit, sourceStart: Unit, sourceEnd: Double): Double
  27. def copy(target: Uint8Array, targetStart: Unit, sourceStart: Double, sourceEnd: Double): Double
  28. def copy(target: Uint8Array, targetStart: Unit, sourceStart: Double): Double
  29. def copy(target: Uint8Array, targetStart: Double, sourceStart: Unit, sourceEnd: Double): Double
  30. def copy(target: Uint8Array, targetStart: Double, sourceStart: Double, sourceEnd: Double): Double
  31. def copy(target: Uint8Array, targetStart: Double, sourceStart: Double): Double
  32. def copy(target: Uint8Array, targetStart: Double): Double
  33. def copy(target: Uint8Array): Double

    Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

    Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

    [TypedArray.prototype.set()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set) performs the same operation, and is available for all TypedArrays, including Node.js Buffers, although it takes different function arguments.

    js import { Buffer } from 'buffer';

    // Create two Buffer instances. const buf1 = Buffer.allocUnsafe(26); const buf2 = Buffer.allocUnsafe(26).fill('!');

    for (let i = 0; i < 26; i++) { // 97 is the decimal ASCII value for 'a'. buf1[i] = i + 97; }

    // Copy buf1 bytes 16 through 19 into buf2 starting at byte 8 of buf2. buf1.copy(buf2, 8, 16, 20); // This is equivalent to: // buf2.set(buf1.subarray(16, 20), 8);

    console.log(buf2.toString('ascii', 0, 25)); // Prints: !!!!!!!!qrst!!!!!!!!!!!!!

    js import { Buffer } from 'buffer';

    // Create a Buffer and copy data from one region to an overlapping region // within the same Buffer.

    const buf = Buffer.allocUnsafe(26);

    for (let i = 0; i < 26; i++) { // 97 is the decimal ASCII value for 'a'. buf[i] = i + 97; }

    buf.copy(buf, 0, 4, 10);

    console.log(buf.toString()); // Prints: efghijghijklmnopqrstuvwxyz

    target

    A Buffer or Uint8Array to copy into.

    returns

    The number of bytes copied.

    Since

    v0.1.90

  34. def copyWithin(target: Double, start: Double, end: Double): Buffer.this.type
    Definition Classes
    Uint8Array
  35. def copyWithin(target: Double, start: Double): Buffer.this.type

    Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    target

    If target is negative, it is treated as length+target where length is the length of the array.

    start

    If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    Definition Classes
    Uint8Array
  36. def entries(): IterableIterator[Tuple2[Double, Double]]

    Returns an array of key, value pairs for every entry in the array

    Returns an array of key, value pairs for every entry in the array

    Definition Classes
    Uint8Array
  37. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def equals(otherBuffer: Uint8Array): Boolean

    Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise.

    Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

    js import { Buffer } from 'buffer';

    const buf1 = Buffer.from('ABC'); const buf2 = Buffer.from('414243', 'hex'); const buf3 = Buffer.from('ABCD');

    console.log(buf1.equals(buf2)); // Prints: true console.log(buf1.equals(buf3)); // Prints: false

    otherBuffer

    A Buffer or Uint8Array with which to compare buf.

    Since

    v0.11.13

  39. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  40. def every(predicate: Function3[Double, Double, Buffer.this.type, Any], thisArg: Any): Boolean
    Definition Classes
    Uint8Array
  41. def every(predicate: Function3[Double, Double, Buffer.this.type, Any]): Boolean

    Determines whether all the members of an array satisfy the specified test.

    Determines whether all the members of an array satisfy the specified test.

    predicate

    A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

    Definition Classes
    Uint8Array
  42. def fill(value: Double, offset: Unit, end: Unit, encoding: BufferEncoding): Buffer.this.type
  43. def fill(value: Double, offset: Unit, end: Double, encoding: BufferEncoding): Buffer.this.type
  44. def fill(value: Double, offset: Double, end: Unit, encoding: BufferEncoding): Buffer.this.type
  45. def fill(value: Double, offset: Double, end: Double, encoding: BufferEncoding): Buffer.this.type
  46. def fill(value: Uint8Array, offset: Unit, end: Unit, encoding: BufferEncoding): Buffer.this.type
  47. def fill(value: Uint8Array, offset: Unit, end: Double, encoding: BufferEncoding): Buffer.this.type
  48. def fill(value: Uint8Array, offset: Unit, end: Double): Buffer.this.type
  49. def fill(value: Uint8Array, offset: Double, end: Unit, encoding: BufferEncoding): Buffer.this.type
  50. def fill(value: Uint8Array, offset: Double, end: Double, encoding: BufferEncoding): Buffer.this.type
  51. def fill(value: Uint8Array, offset: Double, end: Double): Buffer.this.type
  52. def fill(value: Uint8Array, offset: Double): Buffer.this.type
  53. def fill(value: Uint8Array): Buffer.this.type
  54. def fill(value: String, offset: Unit, end: Unit, encoding: BufferEncoding): Buffer.this.type
  55. def fill(value: String, offset: Unit, end: Double, encoding: BufferEncoding): Buffer.this.type
  56. def fill(value: String, offset: Unit, end: Double): Buffer.this.type
  57. def fill(value: String, offset: Double, end: Unit, encoding: BufferEncoding): Buffer.this.type
  58. def fill(value: String, offset: Double, end: Double, encoding: BufferEncoding): Buffer.this.type
  59. def fill(value: String, offset: Double, end: Double): Buffer.this.type
  60. def fill(value: String, offset: Double): Buffer.this.type
  61. def fill(value: String): Buffer.this.type

    Fills buf with the specified value.

    Fills buf with the specified value. If the offset and end are not given, the entire buf will be filled:

    js import { Buffer } from 'buffer';

    // Fill a Buffer with the ASCII character 'h'.

    const b = Buffer.allocUnsafe(50).fill('h');

    console.log(b.toString()); // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh

    value is coerced to a uint32 value if it is not a string, Buffer, or integer. If the resulting integer is greater than 255 (decimal), buf will be filled with value &#x26; 255.

    If the final write of a fill() operation falls on a multi-byte character, then only the bytes of that character that fit into buf are written:

    js import { Buffer } from 'buffer';

    // Fill a Buffer with character that takes up two bytes in UTF-8.

    console.log(Buffer.allocUnsafe(5).fill('\\u0222')); // Prints: <Buffer c8 a2 c8 a2 c8>

    If value contains invalid characters, it is truncated; if no valid fill data remains, an exception is thrown:

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(5);

    console.log(buf.fill('a')); // Prints: <Buffer 61 61 61 61 61> console.log(buf.fill('aazz', 'hex')); // Prints: <Buffer aa aa aa aa aa> console.log(buf.fill('zz', 'hex')); // Throws an exception.

    value

    The value with which to fill buf.

    returns

    A reference to buf.

    Since

    v0.5.0

  62. def fill(value: Double, start: Unit, end: Double): Buffer.this.type
    Definition Classes
    Uint8Array
  63. def fill(value: Double, start: Double, end: Double): Buffer.this.type
    Definition Classes
    Uint8Array
  64. def fill(value: Double, start: Double): Buffer.this.type
    Definition Classes
    Uint8Array
  65. def fill(value: Double): Buffer.this.type

    Returns the this object after filling the section identified by start and end with value

    Returns the this object after filling the section identified by start and end with value

    value

    value to fill array section with

    Definition Classes
    Uint8Array
  66. def filter(predicate: Function3[Double, Double, Buffer.this.type, Any], thisArg: Any): Uint8Array
    Definition Classes
    Uint8Array
  67. def filter(predicate: Function3[Double, Double, Buffer.this.type, Any]): Uint8Array

    Returns the elements of an array that meet the condition specified in a callback function.

    Returns the elements of an array that meet the condition specified in a callback function.

    predicate

    A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

    Definition Classes
    Uint8Array
  68. def find(predicate: Function3[Double, Double, Buffer.this.type, Boolean], thisArg: Any): UndefOr[Double]
    Definition Classes
    Uint8Array
  69. def find(predicate: Function3[Double, Double, Buffer.this.type, Boolean]): UndefOr[Double]

    Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    predicate

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    Definition Classes
    Uint8Array
  70. def findIndex(predicate: Function3[Double, Double, Buffer.this.type, Boolean], thisArg: Any): Double
    Definition Classes
    Uint8Array
  71. def findIndex(predicate: Function3[Double, Double, Buffer.this.type, Boolean]): Double

    Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    predicate

    find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    Definition Classes
    Uint8Array
  72. def forEach(callbackfn: Function3[Double, Double, Buffer.this.type, Unit], thisArg: Any): Unit
    Definition Classes
    Uint8Array
  73. def forEach(callbackfn: Function3[Double, Double, Buffer.this.type, Unit]): Unit

    Performs the specified action for each element in an array.

    Performs the specified action for each element in an array.

    callbackfn

    A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    Definition Classes
    Uint8Array
  74. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  75. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  76. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. def includes(value: Double, byteOffset: Unit, encoding: BufferEncoding): Boolean
  78. def includes(value: Double, byteOffset: Double, encoding: BufferEncoding): Boolean
  79. def includes(value: Double, byteOffset: Double): Boolean
  80. def includes(value: Double): Boolean
  81. def includes(value: String, byteOffset: Unit, encoding: BufferEncoding): Boolean
  82. def includes(value: String, byteOffset: Double, encoding: BufferEncoding): Boolean
  83. def includes(value: String, byteOffset: Double): Boolean
  84. def includes(value: String): Boolean

    Equivalent to buf.indexOf() !== -1.

    Equivalent to buf.indexOf() !== -1.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from('this is a buffer');

    console.log(buf.includes('this')); // Prints: true console.log(buf.includes('is')); // Prints: true console.log(buf.includes(Buffer.from('a buffer'))); // Prints: true console.log(buf.includes(97)); // Prints: true (97 is the decimal ASCII value for 'a') console.log(buf.includes(Buffer.from('a buffer example'))); // Prints: false console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8))); // Prints: true console.log(buf.includes('this', 4)); // Prints: false

    value

    What to search for.

    returns

    true if value was found in buf, false otherwise.

    Since

    v5.3.0

  85. def includes(value: Buffer, byteOffset: Unit, encoding: BufferEncoding): Boolean
  86. def includes(value: Buffer, byteOffset: Double, encoding: BufferEncoding): Boolean
  87. def includes(value: Buffer, byteOffset: Double): Boolean
  88. def includes(value: Buffer): Boolean
  89. def indexOf(value: Double, byteOffset: Unit, encoding: BufferEncoding): Double
  90. def indexOf(value: Double, byteOffset: Double, encoding: BufferEncoding): Double
  91. def indexOf(value: Uint8Array, byteOffset: Unit, encoding: BufferEncoding): Double
  92. def indexOf(value: Uint8Array, byteOffset: Double, encoding: BufferEncoding): Double
  93. def indexOf(value: Uint8Array, byteOffset: Double): Double
  94. def indexOf(value: Uint8Array): Double
  95. def indexOf(value: String, byteOffset: Unit, encoding: BufferEncoding): Double
  96. def indexOf(value: String, byteOffset: Double, encoding: BufferEncoding): Double
  97. def indexOf(value: String, byteOffset: Double): Double
  98. def indexOf(value: String): Double

    If value is:

    If value is:

    * a string, value is interpreted according to the character encoding inencoding. * a Buffer or [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), value will be used in its entirety. To compare a partial Buffer, use buf.slice(). * a number, value will be interpreted as an unsigned 8-bit integer value between 0 and 255.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from('this is a buffer');

    console.log(buf.indexOf('this')); // Prints: 0 console.log(buf.indexOf('is')); // Prints: 2 console.log(buf.indexOf(Buffer.from('a buffer'))); // Prints: 8 console.log(buf.indexOf(97)); // Prints: 8 (97 is the decimal ASCII value for 'a') console.log(buf.indexOf(Buffer.from('a buffer example'))); // Prints: -1 console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8))); // Prints: 8

    const utf16Buffer = Buffer.from('\\u039a\\u0391\\u03a3\\u03a3\\u0395', 'utf16le');

    console.log(utf16Buffer.indexOf('\\u03a3', 0, 'utf16le')); // Prints: 4 console.log(utf16Buffer.indexOf('\\u03a3', -4, 'utf16le')); // Prints: 6

    If value is not a string, number, or Buffer, this method will throw aTypeError. If value is a number, it will be coerced to a valid byte value, an integer between 0 and 255.

    If byteOffset is not a number, it will be coerced to a number. If the result of coercion is NaN or 0, then the entire buffer will be searched. This behavior matches [String.prototype.indexOf()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf).

    js import { Buffer } from 'buffer';

    const b = Buffer.from('abcdef');

    // Passing a value that's a number, but not a valid byte. // Prints: 2, equivalent to searching for 99 or 'c'. console.log(b.indexOf(99.9)); console.log(b.indexOf(256 + 99));

    // Passing a byteOffset that coerces to NaN or 0. // Prints: 1, searching the whole buffer. console.log(b.indexOf('b', undefined)); console.log(b.indexOf('b', {})); console.log(b.indexOf('b', null)); console.log(b.indexOf('b', []));

    If value is an empty string or empty Buffer and byteOffset is less than buf.length, byteOffset will be returned. If value is empty andbyteOffset is at least buf.length, buf.length will be returned.

    value

    What to search for.

    returns

    The index of the first occurrence of value in buf, or -1 if buf does not contain value.

    Since

    v1.5.0

  99. def indexOf(searchElement: Double, fromIndex: Double): Double
    Definition Classes
    Uint8Array
  100. def indexOf(searchElement: Double): Double

    Returns the index of the first occurrence of a value in an array.

    Returns the index of the first occurrence of a value in an array.

    searchElement

    The value to locate in the array.

    Definition Classes
    Uint8Array
  101. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  102. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  103. val iterator: Function0[IterableIterator[Double]]
    Definition Classes
    Uint8Array
    Annotations
    @JSName(js.Symbol.iterator)
  104. def join(separator: String): String
    Definition Classes
    Uint8Array
  105. def join(): String

    Adds all the elements of an array separated by the specified separator string.

    Adds all the elements of an array separated by the specified separator string.

    Definition Classes
    Uint8Array
  106. def keys(): IterableIterator[Double]

    Returns an list of keys in the array

    Returns an list of keys in the array

    Definition Classes
    Uint8Array
  107. def lastIndexOf(value: Double, byteOffset: Unit, encoding: BufferEncoding): Double
  108. def lastIndexOf(value: Double, byteOffset: Double, encoding: BufferEncoding): Double
  109. def lastIndexOf(value: Uint8Array, byteOffset: Unit, encoding: BufferEncoding): Double
  110. def lastIndexOf(value: Uint8Array, byteOffset: Double, encoding: BufferEncoding): Double
  111. def lastIndexOf(value: Uint8Array, byteOffset: Double): Double
  112. def lastIndexOf(value: Uint8Array): Double
  113. def lastIndexOf(value: String, byteOffset: Unit, encoding: BufferEncoding): Double
  114. def lastIndexOf(value: String, byteOffset: Double, encoding: BufferEncoding): Double
  115. def lastIndexOf(value: String, byteOffset: Double): Double
  116. def lastIndexOf(value: String): Double

    Identical to buf.indexOf(), except the last occurrence of value is found rather than the first occurrence.

    Identical to buf.indexOf(), except the last occurrence of value is found rather than the first occurrence.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from('this buffer is a buffer');

    console.log(buf.lastIndexOf('this')); // Prints: 0 console.log(buf.lastIndexOf('buffer')); // Prints: 17 console.log(buf.lastIndexOf(Buffer.from('buffer'))); // Prints: 17 console.log(buf.lastIndexOf(97)); // Prints: 15 (97 is the decimal ASCII value for 'a') console.log(buf.lastIndexOf(Buffer.from('yolo'))); // Prints: -1 console.log(buf.lastIndexOf('buffer', 5)); // Prints: 5 console.log(buf.lastIndexOf('buffer', 4)); // Prints: -1

    const utf16Buffer = Buffer.from('\\u039a\\u0391\\u03a3\\u03a3\\u0395', 'utf16le');

    console.log(utf16Buffer.lastIndexOf('\\u03a3', undefined, 'utf16le')); // Prints: 6 console.log(utf16Buffer.lastIndexOf('\\u03a3', -5, 'utf16le')); // Prints: 4

    If value is not a string, number, or Buffer, this method will throw aTypeError. If value is a number, it will be coerced to a valid byte value, an integer between 0 and 255.

    If byteOffset is not a number, it will be coerced to a number. Any arguments that coerce to NaN, like {} or undefined, will search the whole buffer. This behavior matches [String.prototype.lastIndexOf()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf).

    js import { Buffer } from 'buffer';

    const b = Buffer.from('abcdef');

    // Passing a value that's a number, but not a valid byte. // Prints: 2, equivalent to searching for 99 or 'c'. console.log(b.lastIndexOf(99.9)); console.log(b.lastIndexOf(256 + 99));

    // Passing a byteOffset that coerces to NaN. // Prints: 1, searching the whole buffer. console.log(b.lastIndexOf('b', undefined)); console.log(b.lastIndexOf('b', {}));

    // Passing a byteOffset that coerces to 0. // Prints: -1, equivalent to passing 0. console.log(b.lastIndexOf('b', null)); console.log(b.lastIndexOf('b', []));

    If value is an empty string or empty Buffer, byteOffset will be returned.

    value

    What to search for.

    returns

    The index of the last occurrence of value in buf, or -1 if buf does not contain value.

    Since

    v6.0.0

  117. def lastIndexOf(searchElement: Double, fromIndex: Double): Double
    Definition Classes
    Uint8Array
  118. def lastIndexOf(searchElement: Double): Double

    Returns the index of the last occurrence of a value in an array.

    Returns the index of the last occurrence of a value in an array.

    searchElement

    The value to locate in the array.

    Definition Classes
    Uint8Array
  119. val length: Double

    The length of the array.

    The length of the array.

    Definition Classes
    Uint8Array
  120. def map(callbackfn: Function3[Double, Double, Buffer.this.type, Double], thisArg: Any): Uint8Array
    Definition Classes
    Uint8Array
  121. def map(callbackfn: Function3[Double, Double, Buffer.this.type, Double]): Uint8Array

    Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Calls a defined callback function on each element of an array, and returns an array that contains the results.

    callbackfn

    A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    Definition Classes
    Uint8Array
  122. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  123. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  124. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  125. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  126. def readBigInt64BE(offset: Double): BigInt
  127. def readBigInt64BE(): BigInt

    Reads a signed, big-endian 64-bit integer from buf at the specified offset.

    Reads a signed, big-endian 64-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    Since

    v12.0.0, v10.20.0

  128. def readBigInt64LE(offset: Double): BigInt
  129. def readBigInt64LE(): BigInt

    Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

    Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    Since

    v12.0.0, v10.20.0

  130. def readBigUInt64BE(offset: Double): BigInt
  131. def readBigUInt64BE(): BigInt

    Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

    Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

    This function is also available under the readBigUint64BE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

    console.log(buf.readBigUInt64BE(0)); // Prints: 4294967295n

    Since

    v12.0.0, v10.20.0

  132. def readBigUInt64LE(offset: Double): BigInt
  133. def readBigUInt64LE(): BigInt

    Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

    Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

    This function is also available under the readBigUint64LE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

    console.log(buf.readBigUInt64LE(0)); // Prints: 18446744069414584320n

    Since

    v12.0.0, v10.20.0

  134. def readDoubleBE(offset: Double): Double
  135. def readDoubleBE(): Double

    Reads a 64-bit, big-endian double from buf at the specified offset.

    Reads a 64-bit, big-endian double from buf at the specified offset.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

    console.log(buf.readDoubleBE(0)); // Prints: 8.20788039913184e-304

    Since

    v0.11.15

  136. def readDoubleLE(offset: Double): Double
  137. def readDoubleLE(): Double

    Reads a 64-bit, little-endian double from buf at the specified offset.

    Reads a 64-bit, little-endian double from buf at the specified offset.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

    console.log(buf.readDoubleLE(0)); // Prints: 5.447603722011605e-270 console.log(buf.readDoubleLE(1)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.11.15

  138. def readFloatBE(offset: Double): Double
  139. def readFloatBE(): Double

    Reads a 32-bit, big-endian float from buf at the specified offset.

    Reads a 32-bit, big-endian float from buf at the specified offset.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4]);

    console.log(buf.readFloatBE(0)); // Prints: 2.387939260590663e-38

    Since

    v0.11.15

  140. def readFloatLE(offset: Double): Double
  141. def readFloatLE(): Double

    Reads a 32-bit, little-endian float from buf at the specified offset.

    Reads a 32-bit, little-endian float from buf at the specified offset.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4]);

    console.log(buf.readFloatLE(0)); // Prints: 1.539989614439558e-36 console.log(buf.readFloatLE(1)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.11.15

  142. def readInt16BE(offset: Double): Double
  143. def readInt16BE(): Double

    Reads a signed, big-endian 16-bit integer from buf at the specified offset.

    Reads a signed, big-endian 16-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 5]);

    console.log(buf.readInt16BE(0)); // Prints: 5

    Since

    v0.5.5

  144. def readInt16LE(offset: Double): Double
  145. def readInt16LE(): Double

    Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

    Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 5]);

    console.log(buf.readInt16LE(0)); // Prints: 1280 console.log(buf.readInt16LE(1)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.5.5

  146. def readInt32BE(offset: Double): Double
  147. def readInt32BE(): Double

    Reads a signed, big-endian 32-bit integer from buf at the specified offset.

    Reads a signed, big-endian 32-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 0, 0, 5]);

    console.log(buf.readInt32BE(0)); // Prints: 5

    Since

    v0.5.5

  148. def readInt32LE(offset: Double): Double
  149. def readInt32LE(): Double

    Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

    Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 0, 0, 5]);

    console.log(buf.readInt32LE(0)); // Prints: 83886080 console.log(buf.readInt32LE(1)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.5.5

  150. def readInt8(offset: Double): Double
  151. def readInt8(): Double

    Reads a signed 8-bit integer from buf at the specified offset.

    Reads a signed 8-bit integer from buf at the specified offset.

    Integers read from a Buffer are interpreted as two's complement signed values.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([-1, 5]);

    console.log(buf.readInt8(0)); // Prints: -1 console.log(buf.readInt8(1)); // Prints: 5 console.log(buf.readInt8(2)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.5.0

  152. def readIntBE(offset: Double, byteLength: Double): Double

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy.

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readIntBE(0, 6).toString(16)); // Prints: 1234567890ab console.log(buf.readIntBE(1, 6).toString(16)); // Throws ERR_OUT_OF_RANGE. console.log(buf.readIntBE(1, 0).toString(16)); // Throws ERR_OUT_OF_RANGE.

    offset

    Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Since

    v0.11.15

  153. def readIntLE(offset: Double, byteLength: Double): Double

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy.

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readIntLE(0, 6).toString(16)); // Prints: -546f87a9cbee

    offset

    Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Since

    v0.11.15

  154. def readUInt16BE(offset: Double): Double
  155. def readUInt16BE(): Double

    Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

    Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint16BE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56]);

    console.log(buf.readUInt16BE(0).toString(16)); // Prints: 1234 console.log(buf.readUInt16BE(1).toString(16)); // Prints: 3456

    Since

    v0.5.5

  156. def readUInt16LE(offset: Double): Double
  157. def readUInt16LE(): Double

    Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

    Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint16LE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56]);

    console.log(buf.readUInt16LE(0).toString(16)); // Prints: 3412 console.log(buf.readUInt16LE(1).toString(16)); // Prints: 5634 console.log(buf.readUInt16LE(2).toString(16)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.5.5

  158. def readUInt32BE(offset: Double): Double
  159. def readUInt32BE(): Double

    Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

    Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint32BE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

    console.log(buf.readUInt32BE(0).toString(16)); // Prints: 12345678

    Since

    v0.5.5

  160. def readUInt32LE(offset: Double): Double
  161. def readUInt32LE(): Double

    Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

    Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

    This function is also available under the readUint32LE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

    console.log(buf.readUInt32LE(0).toString(16)); // Prints: 78563412 console.log(buf.readUInt32LE(1).toString(16)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.5.5

  162. def readUInt8(offset: Double): Double
  163. def readUInt8(): Double

    Reads an unsigned 8-bit integer from buf at the specified offset.

    Reads an unsigned 8-bit integer from buf at the specified offset.

    This function is also available under the readUint8 alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([1, -2]);

    console.log(buf.readUInt8(0)); // Prints: 1 console.log(buf.readUInt8(1)); // Prints: 254 console.log(buf.readUInt8(2)); // Throws ERR_OUT_OF_RANGE.

    Since

    v0.5.0

  164. def readUIntBE(offset: Double, byteLength: Double): Double

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.

    This function is also available under the readUintBE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readUIntBE(0, 6).toString(16)); // Prints: 1234567890ab console.log(buf.readUIntBE(1, 6).toString(16)); // Throws ERR_OUT_OF_RANGE.

    offset

    Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Since

    v0.11.15

  165. def readUIntLE(offset: Double, byteLength: Double): Double

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.

    This function is also available under the readUintLE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readUIntLE(0, 6).toString(16)); // Prints: ab9078563412

    offset

    Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to read. Must satisfy 0 < byteLength <= 6.

    Since

    v0.11.15

  166. def reduce[U](callbackfn: Function4[U, Double, Double, Buffer.this.type, U], initialValue: U): U

    Calls the specified callback function for all the elements in an array.

    Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    callbackfn

    A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    initialValue

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Definition Classes
    Uint8Array
  167. def reduce(callbackfn: Function4[Double, Double, Double, Buffer.this.type, Double], initialValue: Double): Double
    Definition Classes
    Uint8Array
  168. def reduce(callbackfn: Function4[Double, Double, Double, Buffer.this.type, Double]): Double

    Calls the specified callback function for all the elements in an array.

    Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    callbackfn

    A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Definition Classes
    Uint8Array
  169. def reduceRight[U](callbackfn: Function4[U, Double, Double, Buffer.this.type, U], initialValue: U): U

    Calls the specified callback function for all the elements in an array, in descending order.

    Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    callbackfn

    A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    initialValue

    If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Definition Classes
    Uint8Array
  170. def reduceRight(callbackfn: Function4[Double, Double, Double, Buffer.this.type, Double], initialValue: Double): Double
    Definition Classes
    Uint8Array
  171. def reduceRight(callbackfn: Function4[Double, Double, Double, Buffer.this.type, Double]): Double

    Calls the specified callback function for all the elements in an array, in descending order.

    Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    callbackfn

    A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Definition Classes
    Uint8Array
  172. def reverse(): Uint8Array

    Reverses the elements in an Array.

    Reverses the elements in an Array.

    Definition Classes
    Uint8Array
  173. def set(array: ArrayLike[Double], offset: Double): Unit
    Definition Classes
    Uint8Array
  174. def set(array: ArrayLike[Double]): Unit

    Sets a value or an array of values.

    Sets a value or an array of values.

    array

    A typed or untyped array of values to set.

    Definition Classes
    Uint8Array
  175. def slice(start: Unit, end: Double): Uint8Array
    Definition Classes
    Uint8Array
  176. def slice(start: Double, end: Double): Uint8Array
    Definition Classes
    Uint8Array
  177. def slice(start: Double): Uint8Array
    Definition Classes
    Uint8Array
  178. def slice(): Uint8Array

    Returns a section of an array.

    Returns a section of an array.

    Definition Classes
    Uint8Array
  179. def some(predicate: Function3[Double, Double, Buffer.this.type, Any], thisArg: Any): Boolean
    Definition Classes
    Uint8Array
  180. def some(predicate: Function3[Double, Double, Buffer.this.type, Any]): Boolean

    Determines whether the specified callback function returns true for any element of an array.

    Determines whether the specified callback function returns true for any element of an array.

    predicate

    A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

    Definition Classes
    Uint8Array
  181. def sort(compareFn: Function2[Double, Double, Double]): Buffer.this.type
    Definition Classes
    Uint8Array
  182. def sort(): Buffer.this.type

    Sorts an array.

    Sorts an array.

    Definition Classes
    Uint8Array
  183. def subarray(begin: Unit, end: Double): Uint8Array
    Definition Classes
    Uint8Array
  184. def subarray(begin: Double, end: Double): Uint8Array
    Definition Classes
    Uint8Array
  185. def subarray(begin: Double): Uint8Array
    Definition Classes
    Uint8Array
  186. def subarray(): Uint8Array

    Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

    Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

    Definition Classes
    Uint8Array
  187. def swap16(): Buffer

    Interprets buf as an array of unsigned 16-bit integers and swaps the byte order _in-place_.

    Interprets buf as an array of unsigned 16-bit integers and swaps the byte order _in-place_. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 2.

    js import { Buffer } from 'buffer';

    const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

    console.log(buf1); // Prints: <Buffer 01 02 03 04 05 06 07 08>

    buf1.swap16();

    console.log(buf1); // Prints: <Buffer 02 01 04 03 06 05 08 07>

    const buf2 = Buffer.from([0x1, 0x2, 0x3]);

    buf2.swap16(); // Throws ERR_INVALID_BUFFER_SIZE.

    One convenient use of buf.swap16() is to perform a fast in-place conversion between UTF-16 little-endian and UTF-16 big-endian:

    js import { Buffer } from 'buffer';

    const buf = Buffer.from('This is little-endian UTF-16', 'utf16le'); buf.swap16(); // Convert to big-endian UTF-16 text.

    returns

    A reference to buf.

    Since

    v5.10.0

  188. def swap32(): Buffer

    Interprets buf as an array of unsigned 32-bit integers and swaps the byte order _in-place_.

    Interprets buf as an array of unsigned 32-bit integers and swaps the byte order _in-place_. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 4.

    js import { Buffer } from 'buffer';

    const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

    console.log(buf1); // Prints: <Buffer 01 02 03 04 05 06 07 08>

    buf1.swap32();

    console.log(buf1); // Prints: <Buffer 04 03 02 01 08 07 06 05>

    const buf2 = Buffer.from([0x1, 0x2, 0x3]);

    buf2.swap32(); // Throws ERR_INVALID_BUFFER_SIZE.

    returns

    A reference to buf.

    Since

    v5.10.0

  189. def swap64(): Buffer

    Interprets buf as an array of 64-bit numbers and swaps byte order _in-place_.

    Interprets buf as an array of 64-bit numbers and swaps byte order _in-place_. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 8.

    js import { Buffer } from 'buffer';

    const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

    console.log(buf1); // Prints: <Buffer 01 02 03 04 05 06 07 08>

    buf1.swap64();

    console.log(buf1); // Prints: <Buffer 08 07 06 05 04 03 02 01>

    const buf2 = Buffer.from([0x1, 0x2, 0x3]);

    buf2.swap64(); // Throws ERR_INVALID_BUFFER_SIZE.

    returns

    A reference to buf.

    Since

    v6.3.0

  190. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  191. def toJSON(): Data

    Returns a JSON representation of buf.

    Returns a JSON representation of buf. [JSON.stringify()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify) implicitly calls this function when stringifying a Buffer instance.

    Buffer.from() accepts objects in the format returned from this method. In particular, Buffer.from(buf.toJSON()) works like Buffer.from(buf).

    js import { Buffer } from 'buffer';

    const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]); const json = JSON.stringify(buf);

    console.log(json); // Prints: {"type":"Buffer","data":[1,2,3,4,5]}

    const copy = JSON.parse(json, (key, value) => { return value &#x26;&#x26; value.type === 'Buffer' ? Buffer.from(value) : value; });

    console.log(copy); // Prints: <Buffer 01 02 03 04 05>

    Since

    v0.9.2

  192. def toLocaleString(): String
    Definition Classes
    Object
  193. def toString(encoding: Unit, start: Unit, end: Double): String
  194. def toString(encoding: Unit, start: Double, end: Double): String
  195. def toString(encoding: Unit, start: Double): String
  196. def toString(encoding: BufferEncoding, start: Unit, end: Double): String
  197. def toString(encoding: BufferEncoding, start: Double, end: Double): String
  198. def toString(encoding: BufferEncoding, start: Double): String
  199. def toString(encoding: BufferEncoding): String
  200. def toString(): String
    Definition Classes
    AnyRef → Any
  201. val toStringTag: Uint8Array
    Definition Classes
    Uint8Array
    Annotations
    @JSName(js.Symbol.toStringTag)
  202. def valueOf(): Any
    Definition Classes
    Object
  203. def values(): IterableIterator[Double]

    Returns an list of values in the array

    Returns an list of values in the array

    Definition Classes
    Uint8Array
  204. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  205. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  206. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  207. def write(string: String, offset: Double, length: Double, encoding: BufferEncoding): Double
  208. def write(string: String, offset: Double, length: Double): Double
  209. def write(string: String, offset: Double, encoding: BufferEncoding): Double
  210. def write(string: String, offset: Double): Double
  211. def write(string: String, encoding: BufferEncoding): Double
  212. def write(string: String): Double

    Writes string to buf at offset according to the character encoding inencoding.

    Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did not contain enough space to fit the entire string, only part of string will be written. However, partially encoded characters will not be written.

    js import { Buffer } from 'buffer';

    const buf = Buffer.alloc(256);

    const len = buf.write('\\u00bd + \\u00bc = \\u00be', 0);

    console.log(${len} bytes: ${buf.toString('utf8', 0, len)}); // Prints: 12 bytes: ½ + ¼ = ¾

    const buffer = Buffer.alloc(10);

    const length = buffer.write('abcd', 8);

    console.log(${length} bytes: ${buffer.toString('utf8', 8, 10)}); // Prints: 2 bytes : ab

    string

    String to write to buf.

    returns

    Number of bytes written.

    Since

    v0.1.90

  213. def writeBigInt64BE(value: BigInt, offset: Double): Double
  214. def writeBigInt64BE(value: BigInt): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian.

    value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigInt64BE(0x0102030405060708n, 0);

    console.log(buf); // Prints: <Buffer 01 02 03 04 05 06 07 08>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

  215. def writeBigInt64LE(value: BigInt, offset: Double): Double
  216. def writeBigInt64LE(value: BigInt): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian.

    value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigInt64LE(0x0102030405060708n, 0);

    console.log(buf); // Prints: <Buffer 08 07 06 05 04 03 02 01>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

  217. def writeBigUInt64BE(value: BigInt, offset: Double): Double
  218. def writeBigUInt64BE(value: BigInt): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian.

    This function is also available under the writeBigUint64BE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

    console.log(buf); // Prints: <Buffer de ca fa fe ca ce fa de>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

  219. def writeBigUInt64LE(value: BigInt, offset: Double): Double
  220. def writeBigUInt64LE(value: BigInt): Double

    Writes value to buf at the specified offset as little-endian

    Writes value to buf at the specified offset as little-endian

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

    console.log(buf); // Prints: <Buffer de fa ce ca fe fa ca de>

    This function is also available under the writeBigUint64LE alias.

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v12.0.0, v10.20.0

  221. def writeDoubleBE(value: Double, offset: Double): Double
  222. def writeDoubleBE(value: Double): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeDoubleBE(123.456, 0);

    console.log(buf); // Prints: <Buffer 40 5e dd 2f 1a 9f be 77>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.11.15

  223. def writeDoubleLE(value: Double, offset: Double): Double
  224. def writeDoubleLE(value: Double): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything other than a JavaScript number.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeDoubleLE(123.456, 0);

    console.log(buf); // Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.11.15

  225. def writeFloatBE(value: Double, offset: Double): Double
  226. def writeFloatBE(value: Double): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian. Behavior is undefined when value is anything other than a JavaScript number.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeFloatBE(0xcafebabe, 0);

    console.log(buf); // Prints: <Buffer 4f 4a fe bb>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.11.15

  227. def writeFloatLE(value: Double, offset: Double): Double
  228. def writeFloatLE(value: Double): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian. Behavior is undefined when value is anything other than a JavaScript number.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeFloatLE(0xcafebabe, 0);

    console.log(buf); // Prints: <Buffer bb fe 4a 4f>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.11.15

  229. def writeInt16BE(value: Double, offset: Double): Double
  230. def writeInt16BE(value: Double): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

    The value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(2);

    buf.writeInt16BE(0x0102, 0);

    console.log(buf); // Prints: <Buffer 01 02>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  231. def writeInt16LE(value: Double, offset: Double): Double
  232. def writeInt16LE(value: Double): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is anything other than a signed 16-bit integer.

    The value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(2);

    buf.writeInt16LE(0x0304, 0);

    console.log(buf); // Prints: <Buffer 04 03>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  233. def writeInt32BE(value: Double, offset: Double): Double
  234. def writeInt32BE(value: Double): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

    The value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeInt32BE(0x01020304, 0);

    console.log(buf); // Prints: <Buffer 01 02 03 04>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  235. def writeInt32LE(value: Double, offset: Double): Double
  236. def writeInt32LE(value: Double): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is anything other than a signed 32-bit integer.

    The value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeInt32LE(0x05060708, 0);

    console.log(buf); // Prints: <Buffer 08 07 06 05>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  237. def writeInt8(value: Double, offset: Double): Double
  238. def writeInt8(value: Double): Double

    Writes value to buf at the specified offset.

    Writes value to buf at the specified offset. value must be a valid signed 8-bit integer. Behavior is undefined when value is anything other than a signed 8-bit integer.

    value is interpreted and written as a two's complement signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(2);

    buf.writeInt8(2, 0); buf.writeInt8(-2, 1);

    console.log(buf); // Prints: <Buffer 02 fe>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.0

  239. def writeIntBE(value: Double, offset: Double, byteLength: Double): Double

    Writes byteLength bytes of value to buf at the specified offsetas big-endian.

    Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeIntBE(0x1234567890ab, 0, 6);

    console.log(buf); // Prints: <Buffer 12 34 56 78 90 ab>

    value

    Number to be written to buf.

    offset

    Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    returns

    offset plus the number of bytes written.

    Since

    v0.11.15

  240. def writeIntLE(value: Double, offset: Double, byteLength: Double): Double

    Writes byteLength bytes of value to buf at the specified offsetas little-endian.

    Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than a signed integer.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeIntLE(0x1234567890ab, 0, 6);

    console.log(buf); // Prints: <Buffer ab 90 78 56 34 12>

    value

    Number to be written to buf.

    offset

    Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    returns

    offset plus the number of bytes written.

    Since

    v0.11.15

  241. def writeUInt16BE(value: Double, offset: Double): Double
  242. def writeUInt16BE(value: Double): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an unsigned 16-bit integer.

    This function is also available under the writeUint16BE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt16BE(0xdead, 0); buf.writeUInt16BE(0xbeef, 2);

    console.log(buf); // Prints: <Buffer de ad be ef>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  243. def writeUInt16LE(value: Double, offset: Double): Double
  244. def writeUInt16LE(value: Double): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is anything other than an unsigned 16-bit integer.

    This function is also available under the writeUint16LE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt16LE(0xdead, 0); buf.writeUInt16LE(0xbeef, 2);

    console.log(buf); // Prints: <Buffer ad de ef be>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  245. def writeUInt32BE(value: Double, offset: Double): Double
  246. def writeUInt32BE(value: Double): Double

    Writes value to buf at the specified offset as big-endian.

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an unsigned 32-bit integer.

    This function is also available under the writeUint32BE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt32BE(0xfeedface, 0);

    console.log(buf); // Prints: <Buffer fe ed fa ce>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  247. def writeUInt32LE(value: Double, offset: Double): Double
  248. def writeUInt32LE(value: Double): Double

    Writes value to buf at the specified offset as little-endian.

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is anything other than an unsigned 32-bit integer.

    This function is also available under the writeUint32LE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt32LE(0xfeedface, 0);

    console.log(buf); // Prints: <Buffer ce fa ed fe>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  249. def writeUInt8(value: Double, offset: Double): Double
  250. def writeUInt8(value: Double): Double

    Writes value to buf at the specified offset.

    Writes value to buf at the specified offset. value must be a valid unsigned 8-bit integer. Behavior is undefined when value is anything other than an unsigned 8-bit integer.

    This function is also available under the writeUint8 alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt8(0x3, 0); buf.writeUInt8(0x4, 1); buf.writeUInt8(0x23, 2); buf.writeUInt8(0x42, 3);

    console.log(buf); // Prints: <Buffer 03 04 23 42>

    value

    Number to be written to buf.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.0

  251. def writeUIntBE(value: Double, offset: Double, byteLength: Double): Double

    Writes byteLength bytes of value to buf at the specified offsetas big-endian.

    Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

    This function is also available under the writeUintBE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeUIntBE(0x1234567890ab, 0, 6);

    console.log(buf); // Prints: <Buffer 12 34 56 78 90 ab>

    value

    Number to be written to buf.

    offset

    Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

  252. def writeUIntLE(value: Double, offset: Double, byteLength: Double): Double

    Writes byteLength bytes of value to buf at the specified offsetas little-endian.

    Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined when value is anything other than an unsigned integer.

    This function is also available under the writeUintLE alias.

    js import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeUIntLE(0x1234567890ab, 0, 6);

    console.log(buf); // Prints: <Buffer ab 90 78 56 34 12>

    value

    Number to be written to buf.

    offset

    Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

    byteLength

    Number of bytes to write. Must satisfy 0 < byteLength <= 6.

    returns

    offset plus the number of bytes written.

    Since

    v0.5.5

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from _PathLike

Inherited from _KeyLike

Inherited from Uint8Array

Inherited from NumberDictionary[Double]

Inherited from StObject

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped