trait Buffer extends Object with StObject with Uint8Array with _KeyLike with _PathLike
- Annotations
- @JSType() @native()
- Alphabetic
- By Inheritance
- Buffer
- _PathLike
- _KeyLike
- Uint8Array
- NumberDictionary
- StObject
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val buffer: ArrayBuffer
The ArrayBuffer instance referenced by the array.
The ArrayBuffer instance referenced by the array.
- Definition Classes
- Uint8Array
- val byteLength: Double
The length in bytes of the array.
The length in bytes of the array.
- Definition Classes
- Uint8Array
- val byteOffset: Double
The offset in bytes of the array.
The offset in bytes of the array.
- Definition Classes
- Uint8Array
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Unit, sourceStart: Unit, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Unit, sourceStart: Double, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Unit, sourceStart: Double): Double
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double, sourceStart: Unit, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double, sourceStart: Double, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double, sourceStart: Double): Double
- def compare(target: Uint8Array, targetStart: Unit, targetEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Unit, sourceStart: Unit, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Unit, sourceStart: Double, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Unit, sourceStart: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Double, sourceStart: Unit, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Double, sourceStart: Double, sourceEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Double, sourceStart: Double): Double
- def compare(target: Uint8Array, targetStart: Double, targetEnd: Double): Double
- def compare(target: Uint8Array, targetStart: Double): Double
- def compare(target: Uint8Array): Double
Compares
bufwithtargetand returns a number indicating whetherbufcomes before, after, or is the same astargetin sort order.Compares
bufwithtargetand returns a number indicating whetherbufcomes before, after, or is the same astargetin sort order. Comparison is based on the actual sequence of bytes in eachBuffer.*
0is returned iftargetis the same asbuf*1is returned iftargetshould come _before_bufwhen sorted. *-1is returned iftargetshould come _after_bufwhen 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, andsourceEndarguments can be used to limit the comparison to specific ranges withintargetandbufrespectively.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_RANGEis thrown iftargetStart < 0,sourceStart < 0,targetEnd > target.byteLength, orsourceEnd > source.byteLength.- target
A
BufferorUint8Arraywith which to comparebuf.
- Since
v0.11.13
- def copy(target: Uint8Array, targetStart: Unit, sourceStart: Unit, sourceEnd: Double): Double
- def copy(target: Uint8Array, targetStart: Unit, sourceStart: Double, sourceEnd: Double): Double
- def copy(target: Uint8Array, targetStart: Unit, sourceStart: Double): Double
- def copy(target: Uint8Array, targetStart: Double, sourceStart: Unit, sourceEnd: Double): Double
- def copy(target: Uint8Array, targetStart: Double, sourceStart: Double, sourceEnd: Double): Double
- def copy(target: Uint8Array, targetStart: Double, sourceStart: Double): Double
- def copy(target: Uint8Array, targetStart: Double): Double
- def copy(target: Uint8Array): Double
Copies data from a region of
bufto a region intarget, even if thetargetmemory region overlaps withbuf.Copies data from a region of
bufto a region intarget, even if thetargetmemory region overlaps withbuf.[
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.jsBuffers, although it takes different function arguments.js import { Buffer } from 'buffer';// Create two
Bufferinstances. 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
buf1bytes 16 through 19 intobuf2starting at byte 8 ofbuf2. 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
Bufferand copy data from one region to an overlapping region // within the sameBuffer.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
BufferorUint8Arrayto copy into.- returns
The number of bytes copied.
- Since
v0.1.90
- def copyWithin(target: Double, start: Double, end: Double): Buffer.this.type
- Definition Classes
- Uint8Array
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(otherBuffer: Uint8Array): Boolean
Returns
trueif bothbufandotherBufferhave exactly the same bytes,falseotherwise.Returns
trueif bothbufandotherBufferhave exactly the same bytes,falseotherwise. Equivalent tobuf.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
BufferorUint8Arraywith which to comparebuf.
- Since
v0.11.13
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def every(predicate: Function3[Double, Double, Buffer.this.type, Any], thisArg: Any): Boolean
- Definition Classes
- Uint8Array
- 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
- def fill(value: Double, offset: Unit, end: Unit, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Double, offset: Unit, end: Double, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Double, offset: Double, end: Unit, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Double, offset: Double, end: Double, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Uint8Array, offset: Unit, end: Unit, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Uint8Array, offset: Unit, end: Double, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Uint8Array, offset: Unit, end: Double): Buffer.this.type
- def fill(value: Uint8Array, offset: Double, end: Unit, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Uint8Array, offset: Double, end: Double, encoding: BufferEncoding): Buffer.this.type
- def fill(value: Uint8Array, offset: Double, end: Double): Buffer.this.type
- def fill(value: Uint8Array, offset: Double): Buffer.this.type
- def fill(value: Uint8Array): Buffer.this.type
- def fill(value: String, offset: Unit, end: Unit, encoding: BufferEncoding): Buffer.this.type
- def fill(value: String, offset: Unit, end: Double, encoding: BufferEncoding): Buffer.this.type
- def fill(value: String, offset: Unit, end: Double): Buffer.this.type
- def fill(value: String, offset: Double, end: Unit, encoding: BufferEncoding): Buffer.this.type
- def fill(value: String, offset: Double, end: Double, encoding: BufferEncoding): Buffer.this.type
- def fill(value: String, offset: Double, end: Double): Buffer.this.type
- def fill(value: String, offset: Double): Buffer.this.type
- def fill(value: String): Buffer.this.type
Fills
bufwith the specifiedvalue.Fills
bufwith the specifiedvalue. If theoffsetandendare not given, the entirebufwill be filled:js import { Buffer } from 'buffer';// Fill a
Bufferwith the ASCII character 'h'.const b = Buffer.allocUnsafe(50).fill('h');
console.log(b.toString()); // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
valueis coerced to auint32value if it is not a string,Buffer, or integer. If the resulting integer is greater than255(decimal),bufwill be filled withvalue & 255.If the final write of a
fill()operation falls on a multi-byte character, then only the bytes of that character that fit intobufare written:js import { Buffer } from 'buffer';// Fill a
Bufferwith character that takes up two bytes in UTF-8.console.log(Buffer.allocUnsafe(5).fill('\\u0222')); // Prints: <Buffer c8 a2 c8 a2 c8>
If
valuecontains 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
- def fill(value: Double, start: Unit, end: Double): Buffer.this.type
- Definition Classes
- Uint8Array
- def fill(value: Double, start: Double, end: Double): Buffer.this.type
- Definition Classes
- Uint8Array
- def fill(value: Double, start: Double): Buffer.this.type
- Definition Classes
- Uint8Array
- 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
- def filter(predicate: Function3[Double, Double, Buffer.this.type, Any], thisArg: Any): Uint8Array
- Definition Classes
- Uint8Array
- 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
- def find(predicate: Function3[Double, Double, Buffer.this.type, Boolean], thisArg: Any): UndefOr[Double]
- Definition Classes
- Uint8Array
- 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
- def findIndex(predicate: Function3[Double, Double, Buffer.this.type, Boolean], thisArg: Any): Double
- Definition Classes
- Uint8Array
- 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
- def forEach(callbackfn: Function3[Double, Double, Buffer.this.type, Unit], thisArg: Any): Unit
- Definition Classes
- Uint8Array
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def includes(value: Double, byteOffset: Unit, encoding: BufferEncoding): Boolean
- def includes(value: Double, byteOffset: Double, encoding: BufferEncoding): Boolean
- def includes(value: Double, byteOffset: Double): Boolean
- def includes(value: Double): Boolean
- def includes(value: String, byteOffset: Unit, encoding: BufferEncoding): Boolean
- def includes(value: String, byteOffset: Double, encoding: BufferEncoding): Boolean
- def includes(value: String, byteOffset: Double): Boolean
- 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
trueifvaluewas found inbuf,falseotherwise.
- Since
v5.3.0
- def includes(value: Buffer, byteOffset: Unit, encoding: BufferEncoding): Boolean
- def includes(value: Buffer, byteOffset: Double, encoding: BufferEncoding): Boolean
- def includes(value: Buffer, byteOffset: Double): Boolean
- def includes(value: Buffer): Boolean
- def indexOf(value: Double, byteOffset: Unit, encoding: BufferEncoding): Double
- def indexOf(value: Double, byteOffset: Double, encoding: BufferEncoding): Double
- def indexOf(value: Uint8Array, byteOffset: Unit, encoding: BufferEncoding): Double
- def indexOf(value: Uint8Array, byteOffset: Double, encoding: BufferEncoding): Double
- def indexOf(value: Uint8Array, byteOffset: Double): Double
- def indexOf(value: Uint8Array): Double
- def indexOf(value: String, byteOffset: Unit, encoding: BufferEncoding): Double
- def indexOf(value: String, byteOffset: Double, encoding: BufferEncoding): Double
- def indexOf(value: String, byteOffset: Double): Double
- def indexOf(value: String): Double
If
valueis:If
valueis:* a string,
valueis interpreted according to the character encoding inencoding. * aBufferor [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array),valuewill be used in its entirety. To compare a partialBuffer, usebuf.slice(). * a number,valuewill be interpreted as an unsigned 8-bit integer value between0and255.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
valueis not a string, number, orBuffer, this method will throw aTypeError. Ifvalueis a number, it will be coerced to a valid byte value, an integer between 0 and 255.If
byteOffsetis not a number, it will be coerced to a number. If the result of coercion isNaNor0, 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
valueis an empty string or emptyBufferandbyteOffsetis less thanbuf.length,byteOffsetwill be returned. Ifvalueis empty andbyteOffsetis at leastbuf.length,buf.lengthwill be returned.- value
What to search for.
- returns
The index of the first occurrence of
valueinbuf, or-1ifbufdoes not containvalue.
- Since
v1.5.0
- def indexOf(searchElement: Double, fromIndex: Double): Double
- Definition Classes
- Uint8Array
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- val iterator: Function0[IterableIterator[Double]]
- Definition Classes
- Uint8Array
- Annotations
- @JSName(js.Symbol.iterator)
- def join(separator: String): String
- Definition Classes
- Uint8Array
- 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
- def keys(): IterableIterator[Double]
Returns an list of keys in the array
Returns an list of keys in the array
- Definition Classes
- Uint8Array
- def lastIndexOf(value: Double, byteOffset: Unit, encoding: BufferEncoding): Double
- def lastIndexOf(value: Double, byteOffset: Double, encoding: BufferEncoding): Double
- def lastIndexOf(value: Uint8Array, byteOffset: Unit, encoding: BufferEncoding): Double
- def lastIndexOf(value: Uint8Array, byteOffset: Double, encoding: BufferEncoding): Double
- def lastIndexOf(value: Uint8Array, byteOffset: Double): Double
- def lastIndexOf(value: Uint8Array): Double
- def lastIndexOf(value: String, byteOffset: Unit, encoding: BufferEncoding): Double
- def lastIndexOf(value: String, byteOffset: Double, encoding: BufferEncoding): Double
- def lastIndexOf(value: String, byteOffset: Double): Double
- def lastIndexOf(value: String): Double
Identical to
buf.indexOf(), except the last occurrence ofvalueis found rather than the first occurrence.Identical to
buf.indexOf(), except the last occurrence ofvalueis 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
valueis not a string, number, orBuffer, this method will throw aTypeError. Ifvalueis a number, it will be coerced to a valid byte value, an integer between 0 and 255.If
byteOffsetis not a number, it will be coerced to a number. Any arguments that coerce toNaN, like{}orundefined, 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
valueis an empty string or emptyBuffer,byteOffsetwill be returned.- value
What to search for.
- returns
The index of the last occurrence of
valueinbuf, or-1ifbufdoes not containvalue.
- Since
v6.0.0
- def lastIndexOf(searchElement: Double, fromIndex: Double): Double
- Definition Classes
- Uint8Array
- 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
- val length: Double
The length of the array.
The length of the array.
- Definition Classes
- Uint8Array
- def map(callbackfn: Function3[Double, Double, Buffer.this.type, Double], thisArg: Any): Uint8Array
- Definition Classes
- Uint8Array
- 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
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def readBigInt64BE(offset: Double): BigInt
- def readBigInt64BE(): BigInt
Reads a signed, big-endian 64-bit integer from
bufat the specifiedoffset.Reads a signed, big-endian 64-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare interpreted as two's complement signed values.- Since
v12.0.0, v10.20.0
- def readBigInt64LE(offset: Double): BigInt
- def readBigInt64LE(): BigInt
Reads a signed, little-endian 64-bit integer from
bufat the specifiedoffset.Reads a signed, little-endian 64-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare interpreted as two's complement signed values.- Since
v12.0.0, v10.20.0
- def readBigUInt64BE(offset: Double): BigInt
- def readBigUInt64BE(): BigInt
Reads an unsigned, big-endian 64-bit integer from
bufat the specifiedoffset.Reads an unsigned, big-endian 64-bit integer from
bufat the specifiedoffset.This function is also available under the
readBigUint64BEalias.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
- def readBigUInt64LE(offset: Double): BigInt
- def readBigUInt64LE(): BigInt
Reads an unsigned, little-endian 64-bit integer from
bufat the specifiedoffset.Reads an unsigned, little-endian 64-bit integer from
bufat the specifiedoffset.This function is also available under the
readBigUint64LEalias.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
- def readDoubleBE(offset: Double): Double
- def readDoubleBE(): Double
Reads a 64-bit, big-endian double from
bufat the specifiedoffset.Reads a 64-bit, big-endian double from
bufat the specifiedoffset.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
- def readDoubleLE(offset: Double): Double
- def readDoubleLE(): Double
Reads a 64-bit, little-endian double from
bufat the specifiedoffset.Reads a 64-bit, little-endian double from
bufat the specifiedoffset.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
- def readFloatBE(offset: Double): Double
- def readFloatBE(): Double
Reads a 32-bit, big-endian float from
bufat the specifiedoffset.Reads a 32-bit, big-endian float from
bufat the specifiedoffset.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
- def readFloatLE(offset: Double): Double
- def readFloatLE(): Double
Reads a 32-bit, little-endian float from
bufat the specifiedoffset.Reads a 32-bit, little-endian float from
bufat the specifiedoffset.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
- def readInt16BE(offset: Double): Double
- def readInt16BE(): Double
Reads a signed, big-endian 16-bit integer from
bufat the specifiedoffset.Reads a signed, big-endian 16-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare 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
- def readInt16LE(offset: Double): Double
- def readInt16LE(): Double
Reads a signed, little-endian 16-bit integer from
bufat the specifiedoffset.Reads a signed, little-endian 16-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare 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
- def readInt32BE(offset: Double): Double
- def readInt32BE(): Double
Reads a signed, big-endian 32-bit integer from
bufat the specifiedoffset.Reads a signed, big-endian 32-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare 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
- def readInt32LE(offset: Double): Double
- def readInt32LE(): Double
Reads a signed, little-endian 32-bit integer from
bufat the specifiedoffset.Reads a signed, little-endian 32-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare 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
- def readInt8(offset: Double): Double
- def readInt8(): Double
Reads a signed 8-bit integer from
bufat the specifiedoffset.Reads a signed 8-bit integer from
bufat the specifiedoffset.Integers read from a
Bufferare 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
- def readIntBE(offset: Double, byteLength: Double): Double
Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand interprets the result as a big-endian, two's complement signed value supporting up to 48 bits of accuracy.Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand 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
- def readIntLE(offset: Double, byteLength: Double): Double
Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand interprets the result as a little-endian, two's complement signed value supporting up to 48 bits of accuracy.Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand 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
- def readUInt16BE(offset: Double): Double
- def readUInt16BE(): Double
Reads an unsigned, big-endian 16-bit integer from
bufat the specifiedoffset.Reads an unsigned, big-endian 16-bit integer from
bufat the specifiedoffset.This function is also available under the
readUint16BEalias.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
- def readUInt16LE(offset: Double): Double
- def readUInt16LE(): Double
Reads an unsigned, little-endian 16-bit integer from
bufat the specifiedoffset.Reads an unsigned, little-endian 16-bit integer from
bufat the specifiedoffset.This function is also available under the
readUint16LEalias.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
- def readUInt32BE(offset: Double): Double
- def readUInt32BE(): Double
Reads an unsigned, big-endian 32-bit integer from
bufat the specifiedoffset.Reads an unsigned, big-endian 32-bit integer from
bufat the specifiedoffset.This function is also available under the
readUint32BEalias.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
- def readUInt32LE(offset: Double): Double
- def readUInt32LE(): Double
Reads an unsigned, little-endian 32-bit integer from
bufat the specifiedoffset.Reads an unsigned, little-endian 32-bit integer from
bufat the specifiedoffset.This function is also available under the
readUint32LEalias.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
- def readUInt8(offset: Double): Double
- def readUInt8(): Double
Reads an unsigned 8-bit integer from
bufat the specifiedoffset.Reads an unsigned 8-bit integer from
bufat the specifiedoffset.This function is also available under the
readUint8alias.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
- def readUIntBE(offset: Double, byteLength: Double): Double
Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand interprets the result as an unsigned big-endian integer supporting up to 48 bits of accuracy.This function is also available under the
readUintBEalias.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
- def readUIntLE(offset: Double, byteLength: Double): Double
Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.Reads
byteLengthnumber of bytes frombufat the specifiedoffsetand interprets the result as an unsigned, little-endian integer supporting up to 48 bits of accuracy.This function is also available under the
readUintLEalias.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
- 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
- def reduce(callbackfn: Function4[Double, Double, Double, Buffer.this.type, Double], initialValue: Double): Double
- Definition Classes
- Uint8Array
- 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
- 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
- def reduceRight(callbackfn: Function4[Double, Double, Double, Buffer.this.type, Double], initialValue: Double): Double
- Definition Classes
- Uint8Array
- 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
- def reverse(): Uint8Array
Reverses the elements in an Array.
Reverses the elements in an Array.
- Definition Classes
- Uint8Array
- def set(array: ArrayLike[Double], offset: Double): Unit
- Definition Classes
- Uint8Array
- 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
- def slice(start: Unit, end: Double): Uint8Array
- Definition Classes
- Uint8Array
- def slice(start: Double, end: Double): Uint8Array
- Definition Classes
- Uint8Array
- def slice(start: Double): Uint8Array
- Definition Classes
- Uint8Array
- def slice(): Uint8Array
Returns a section of an array.
Returns a section of an array.
- Definition Classes
- Uint8Array
- def some(predicate: Function3[Double, Double, Buffer.this.type, Any], thisArg: Any): Boolean
- Definition Classes
- Uint8Array
- 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
- def sort(compareFn: Function2[Double, Double, Double]): Buffer.this.type
- Definition Classes
- Uint8Array
- def sort(): Buffer.this.type
Sorts an array.
Sorts an array.
- Definition Classes
- Uint8Array
- def subarray(begin: Unit, end: Double): Uint8Array
- Definition Classes
- Uint8Array
- def subarray(begin: Double, end: Double): Uint8Array
- Definition Classes
- Uint8Array
- def subarray(begin: Double): Uint8Array
- Definition Classes
- Uint8Array
- 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
- def swap16(): Buffer
Interprets
bufas an array of unsigned 16-bit integers and swaps the byte order _in-place_.Interprets
bufas an array of unsigned 16-bit integers and swaps the byte order _in-place_. ThrowsERR_INVALID_BUFFER_SIZEifbuf.lengthis 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
- def swap32(): Buffer
Interprets
bufas an array of unsigned 32-bit integers and swaps the byte order _in-place_.Interprets
bufas an array of unsigned 32-bit integers and swaps the byte order _in-place_. ThrowsERR_INVALID_BUFFER_SIZEifbuf.lengthis 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
- def swap64(): Buffer
Interprets
bufas an array of 64-bit numbers and swaps byte order _in-place_.Interprets
bufas an array of 64-bit numbers and swaps byte order _in-place_. ThrowsERR_INVALID_BUFFER_SIZEifbuf.lengthis 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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 aBufferinstance.Buffer.from()accepts objects in the format returned from this method. In particular,Buffer.from(buf.toJSON())works likeBuffer.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 && value.type === 'Buffer' ? Buffer.from(value) : value; });
console.log(copy); // Prints: <Buffer 01 02 03 04 05>
- Since
v0.9.2
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(encoding: Unit, start: Unit, end: Double): String
- def toString(encoding: Unit, start: Double, end: Double): String
- def toString(encoding: Unit, start: Double): String
- def toString(encoding: BufferEncoding, start: Unit, end: Double): String
- def toString(encoding: BufferEncoding, start: Double, end: Double): String
- def toString(encoding: BufferEncoding, start: Double): String
- def toString(encoding: BufferEncoding): String
- def toString(): String
- Definition Classes
- AnyRef → Any
- val toStringTag: Uint8Array
- Definition Classes
- Uint8Array
- Annotations
- @JSName(js.Symbol.toStringTag)
- def valueOf(): Any
- Definition Classes
- Object
- def values(): IterableIterator[Double]
Returns an list of values in the array
Returns an list of values in the array
- Definition Classes
- Uint8Array
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def write(string: String, offset: Double, length: Double, encoding: BufferEncoding): Double
- def write(string: String, offset: Double, length: Double): Double
- def write(string: String, offset: Double, encoding: BufferEncoding): Double
- def write(string: String, offset: Double): Double
- def write(string: String, encoding: BufferEncoding): Double
- def write(string: String): Double
Writes
stringtobufatoffsetaccording to the character encoding inencoding.Writes
stringtobufatoffsetaccording to the character encoding inencoding. Thelengthparameter is the number of bytes to write. Ifbufdid not contain enough space to fit the entire string, only part ofstringwill 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
- def writeBigInt64BE(value: BigInt, offset: Double): Double
- def writeBigInt64BE(value: BigInt): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian.valueis 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
offsetplus the number of bytes written.
- Since
v12.0.0, v10.20.0
- def writeBigInt64LE(value: BigInt, offset: Double): Double
- def writeBigInt64LE(value: BigInt): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian.valueis 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
offsetplus the number of bytes written.
- Since
v12.0.0, v10.20.0
- def writeBigUInt64BE(value: BigInt, offset: Double): Double
- def writeBigUInt64BE(value: BigInt): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian.This function is also available under the
writeBigUint64BEalias.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
offsetplus the number of bytes written.
- Since
v12.0.0, v10.20.0
- def writeBigUInt64LE(value: BigInt, offset: Double): Double
- def writeBigUInt64LE(value: BigInt): Double
Writes
valuetobufat the specifiedoffsetas little-endianWrites
valuetobufat the specifiedoffsetas little-endianjs 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
writeBigUint64LEalias.- value
Number to be written to
buf.- returns
offsetplus the number of bytes written.
- Since
v12.0.0, v10.20.0
- def writeDoubleBE(value: Double, offset: Double): Double
- def writeDoubleBE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian. Thevaluemust be a JavaScript number. Behavior is undefined whenvalueis 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
offsetplus the number of bytes written.
- Since
v0.11.15
- def writeDoubleLE(value: Double, offset: Double): Double
- def writeDoubleLE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian. Thevaluemust be a JavaScript number. Behavior is undefined whenvalueis 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
offsetplus the number of bytes written.
- Since
v0.11.15
- def writeFloatBE(value: Double, offset: Double): Double
- def writeFloatBE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian. Behavior is undefined whenvalueis 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
offsetplus the number of bytes written.
- Since
v0.11.15
- def writeFloatLE(value: Double, offset: Double): Double
- def writeFloatLE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian. Behavior is undefined whenvalueis 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
offsetplus the number of bytes written.
- Since
v0.11.15
- def writeInt16BE(value: Double, offset: Double): Double
- def writeInt16BE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian. Thevaluemust be a valid signed 16-bit integer. Behavior is undefined whenvalueis anything other than a signed 16-bit integer.The
valueis 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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeInt16LE(value: Double, offset: Double): Double
- def writeInt16LE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian. Thevaluemust be a valid signed 16-bit integer. Behavior is undefined whenvalueis anything other than a signed 16-bit integer.The
valueis 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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeInt32BE(value: Double, offset: Double): Double
- def writeInt32BE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian. Thevaluemust be a valid signed 32-bit integer. Behavior is undefined whenvalueis anything other than a signed 32-bit integer.The
valueis 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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeInt32LE(value: Double, offset: Double): Double
- def writeInt32LE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian. Thevaluemust be a valid signed 32-bit integer. Behavior is undefined whenvalueis anything other than a signed 32-bit integer.The
valueis 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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeInt8(value: Double, offset: Double): Double
- def writeInt8(value: Double): Double
Writes
valuetobufat the specifiedoffset.Writes
valuetobufat the specifiedoffset.valuemust be a valid signed 8-bit integer. Behavior is undefined whenvalueis anything other than a signed 8-bit integer.valueis 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
offsetplus the number of bytes written.
- Since
v0.5.0
- def writeIntBE(value: Double, offset: Double, byteLength: Double): Double
Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas big-endian.Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalueis 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
offsetplus the number of bytes written.
- Since
v0.11.15
- def writeIntLE(value: Double, offset: Double, byteLength: Double): Double
Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas little-endian.Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalueis 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
offsetplus the number of bytes written.
- Since
v0.11.15
- def writeUInt16BE(value: Double, offset: Double): Double
- def writeUInt16BE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian. Thevaluemust be a valid unsigned 16-bit integer. Behavior is undefined whenvalueis anything other than an unsigned 16-bit integer.This function is also available under the
writeUint16BEalias.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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeUInt16LE(value: Double, offset: Double): Double
- def writeUInt16LE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian. Thevaluemust be a valid unsigned 16-bit integer. Behavior is undefined whenvalueis anything other than an unsigned 16-bit integer.This function is also available under the
writeUint16LEalias.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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeUInt32BE(value: Double, offset: Double): Double
- def writeUInt32BE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas big-endian.Writes
valuetobufat the specifiedoffsetas big-endian. Thevaluemust be a valid unsigned 32-bit integer. Behavior is undefined whenvalueis anything other than an unsigned 32-bit integer.This function is also available under the
writeUint32BEalias.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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeUInt32LE(value: Double, offset: Double): Double
- def writeUInt32LE(value: Double): Double
Writes
valuetobufat the specifiedoffsetas little-endian.Writes
valuetobufat the specifiedoffsetas little-endian. Thevaluemust be a valid unsigned 32-bit integer. Behavior is undefined whenvalueis anything other than an unsigned 32-bit integer.This function is also available under the
writeUint32LEalias.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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeUInt8(value: Double, offset: Double): Double
- def writeUInt8(value: Double): Double
Writes
valuetobufat the specifiedoffset.Writes
valuetobufat the specifiedoffset.valuemust be a valid unsigned 8-bit integer. Behavior is undefined whenvalueis anything other than an unsigned 8-bit integer.This function is also available under the
writeUint8alias.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
offsetplus the number of bytes written.
- Since
v0.5.0
- def writeUIntBE(value: Double, offset: Double, byteLength: Double): Double
Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas big-endian.Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalueis anything other than an unsigned integer.This function is also available under the
writeUintBEalias.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
offsetplus the number of bytes written.
- Since
v0.5.5
- def writeUIntLE(value: Double, offset: Double, byteLength: Double): Double
Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas little-endian.Writes
byteLengthbytes ofvaluetobufat the specifiedoffsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalueis anything other than an unsigned integer.This function is also available under the
writeUintLEalias.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
offsetplus the number of bytes written.
- Since
v0.5.5
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated