Options
All
  • Public
  • Public/Protected
  • All
Menu

Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

Hierarchy

  • Uint8Array
    • Buffer

Indexable

[index: number]: number

Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

Index

Properties

BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

__@toStringTag

__@toStringTag: "UInt8Array"

buffer

The ArrayBuffer instance referenced by the array.

byteLength

byteLength: number

The length in bytes of the array.

byteOffset

byteOffset: number

The offset in bytes of the array.

constructor

  • Allocates a new buffer containing the given {str}.

    deprecated

    since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

    Parameters

    • str: string

      String to store in buffer.

    • Optional encoding: BufferEncoding

      encoding to use, optional. Default is 'utf8'

    Returns Buffer

  • Allocates a new buffer of {size} octets.

    deprecated

    since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

    Parameters

    • size: number

      count of octets to allocate.

    Returns Buffer

  • Allocates a new buffer containing the given {array} of octets.

    deprecated

    since v10.0.0 - Use Buffer.from(array) instead.

    Parameters

    • array: Uint8Array

      The octets to store.

    Returns Buffer

  • Produces a Buffer backed by the same allocated memory as the given {ArrayBuffer}/{SharedArrayBuffer}.

    deprecated

    since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

    Parameters

    • arrayBuffer: ArrayBuffer | SharedArrayBuffer

      The ArrayBuffer with which to share memory.

    Returns Buffer

  • Allocates a new buffer containing the given {array} of octets.

    deprecated

    since v10.0.0 - Use Buffer.from(array) instead.

    Parameters

    • array: any[]

      The octets to store.

    Returns Buffer

  • Copies the passed {buffer} data onto a new {Buffer} instance.

    deprecated

    since v10.0.0 - Use Buffer.from(buffer) instead.

    Parameters

    • buffer: Buffer

      The buffer to copy.

    Returns Buffer

length

length: number

The length of the array.

Static Uint8Array

Uint8Array: Uint8ArrayConstructor

Static poolSize

poolSize: number

This is the number of bytes used to determine the size of pre-allocated, internal Buffer instances used for pooling. This value may be modified.

Methods

__@iterator

compare

  • compare(otherBuffer: Uint8Array, targetStart?: undefined | number, targetEnd?: undefined | number, sourceStart?: undefined | number, sourceEnd?: undefined | number): number
  • Parameters

    • otherBuffer: Uint8Array
    • Optional targetStart: undefined | number
    • Optional targetEnd: undefined | number
    • Optional sourceStart: undefined | number
    • Optional sourceEnd: undefined | number

    Returns number

copy

  • copy(targetBuffer: Uint8Array, targetStart?: undefined | number, sourceStart?: undefined | number, sourceEnd?: undefined | number): number
  • Parameters

    • targetBuffer: Uint8Array
    • Optional targetStart: undefined | number
    • Optional sourceStart: undefined | number
    • Optional sourceEnd: undefined | number

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

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

    • start: number

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

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

equals

  • equals(otherBuffer: Uint8Array): boolean
  • Parameters

    • otherBuffer: Uint8Array

    Returns boolean

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: number, index: number, array: Uint8Array): boolean
        • Parameters

          • value: number
          • index: number
          • array: Uint8Array

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: string | Uint8Array | number, offset?: undefined | number, end?: undefined | number, encoding?: BufferEncoding): this
  • Parameters

    • value: string | Uint8Array | number
    • Optional offset: undefined | number
    • Optional end: undefined | number
    • Optional encoding: BufferEncoding

    Returns this

filter

  • filter(callbackfn: function, thisArg?: any): Uint8Array
  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

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

        • (value: number, index: number, array: Uint8Array): any
        • Parameters

          • value: number
          • index: number
          • array: Uint8Array

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint8Array

find

  • find(predicate: function, thisArg?: any): number | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Parameters

    • predicate: function

      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.

        • (value: number, index: number, obj: Uint8Array): boolean
        • Parameters

          • value: number
          • index: number
          • obj: Uint8Array

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      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.

        • (value: number, index: number, obj: Uint8Array): boolean
        • Parameters

          • value: number
          • index: number
          • obj: Uint8Array

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

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

        • (value: number, index: number, array: Uint8Array): void
        • Parameters

          • value: number
          • index: number
          • array: Uint8Array

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(value: string | number | Buffer, byteOffset?: undefined | number, encoding?: BufferEncoding): boolean
  • Parameters

    • value: string | number | Buffer
    • Optional byteOffset: undefined | number
    • Optional encoding: BufferEncoding

    Returns boolean

indexOf

  • indexOf(value: string | number | Uint8Array, byteOffset?: undefined | number, encoding?: BufferEncoding): number
  • Parameters

    • value: string | number | Uint8Array
    • Optional byteOffset: undefined | number
    • Optional encoding: BufferEncoding

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

lastIndexOf

  • lastIndexOf(value: string | number | Uint8Array, byteOffset?: undefined | number, encoding?: BufferEncoding): number
  • Parameters

    • value: string | number | Uint8Array
    • Optional byteOffset: undefined | number
    • Optional encoding: BufferEncoding

    Returns number

map

  • map(callbackfn: function, thisArg?: any): Uint8Array
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Parameters

    • callbackfn: function

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

        • (value: number, index: number, array: Uint8Array): number
        • Parameters

          • value: number
          • index: number
          • array: Uint8Array

          Returns number

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint8Array

readDoubleBE

  • readDoubleBE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readDoubleLE

  • readDoubleLE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readFloatBE

  • readFloatBE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readFloatLE

  • readFloatLE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readInt16BE

  • readInt16BE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readInt16LE

  • readInt16LE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readInt32BE

  • readInt32BE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readInt32LE

  • readInt32LE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readInt8

  • readInt8(offset: number): number
  • Parameters

    • offset: number

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number): number
  • Parameters

    • offset: number
    • byteLength: number

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number): number
  • Parameters

    • offset: number
    • byteLength: number

    Returns number

readUInt16BE

  • readUInt16BE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readUInt16LE

  • readUInt16LE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readUInt32BE

  • readUInt32BE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readUInt32LE

  • readUInt32LE(offset: number): number
  • Parameters

    • offset: number

    Returns number

readUInt8

  • readUInt8(offset: number): number
  • Parameters

    • offset: number

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number): number
  • Parameters

    • offset: number
    • byteLength: number

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number): number
  • Parameters

    • offset: number
    • byteLength: number

    Returns number

reduce

  • reduce(callbackfn: function): number
  • reduce(callbackfn: function, initialValue: number): number
  • reduce<U>(callbackfn: function, initialValue: U): U
  • 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.

    Parameters

    • callbackfn: function

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

        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint8Array

          Returns number

    Returns number

  • Parameters

    • callbackfn: function
        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint8Array

          Returns number

    • initialValue: number

    Returns number

  • 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.

    Type parameters

    • U

    Parameters

    • callbackfn: function

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

        • (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array): U
        • Parameters

          • previousValue: U
          • currentValue: number
          • currentIndex: number
          • array: Uint8Array

          Returns U

    • initialValue: U

      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.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): number
  • reduceRight(callbackfn: function, initialValue: number): number
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • 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.

    Parameters

    • callbackfn: function

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

        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint8Array

          Returns number

    Returns number

  • Parameters

    • callbackfn: function
        • (previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array): number
        • Parameters

          • previousValue: number
          • currentValue: number
          • currentIndex: number
          • array: Uint8Array

          Returns number

    • initialValue: number

    Returns number

  • 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.

    Type parameters

    • U

    Parameters

    • callbackfn: function

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

        • (previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array): U
        • Parameters

          • previousValue: U
          • currentValue: number
          • currentIndex: number
          • array: Uint8Array

          Returns U

    • initialValue: U

      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.

    Returns U

reverse

  • reverse(): this
  • Returns this

set

  • set(array: ArrayLike<number>, offset?: undefined | number): void
  • Sets a value or an array of values.

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

    • Optional offset: undefined | number

      The index in the current array at which the values are to be written.

    Returns void

slice

  • slice(begin?: undefined | number, end?: undefined | number): Buffer
  • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

    This method is incompatible with Uint8Array#slice(), which returns a copy of the original memory.

    Parameters

    • Optional begin: undefined | number

      Where the new Buffer will start. Default: 0.

    • Optional end: undefined | number

      Where the new Buffer will end (not inclusive). Default: buf.length.

    Returns Buffer

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: number, index: number, array: Uint8Array): boolean
        • Parameters

          • value: number
          • index: number
          • array: Uint8Array

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

subarray

  • subarray(begin?: undefined | number, end?: undefined | number): Buffer
  • Returns a new Buffer that references the same memory as the original, but offset and cropped by the start and end indices.

    This method is compatible with Uint8Array#subarray().

    Parameters

    • Optional begin: undefined | number

      Where the new Buffer will start. Default: 0.

    • Optional end: undefined | number

      Where the new Buffer will end (not inclusive). Default: buf.length.

    Returns Buffer

swap16

  • swap16(): Buffer
  • Returns Buffer

swap32

  • swap32(): Buffer
  • Returns Buffer

swap64

  • swap64(): Buffer
  • Returns Buffer

toJSON

  • toJSON(): object
  • Returns object

    • data: number[]
    • type: "Buffer"

toLocaleString

  • toLocaleString(): string
  • Converts a number to a string by using the current locale.

    Returns string

toString

  • toString(encoding?: undefined | string, start?: undefined | number, end?: undefined | number): string
  • Parameters

    • Optional encoding: undefined | string
    • Optional start: undefined | number
    • Optional end: undefined | number

    Returns string

values

write

  • write(string: string, encoding?: BufferEncoding): number
  • write(string: string, offset: number, encoding?: BufferEncoding): number
  • write(string: string, offset: number, length: number, encoding?: BufferEncoding): number
  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    • string: string
    • offset: number
    • length: number
    • Optional encoding: BufferEncoding

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeDoubleLE

  • writeDoubleLE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeFloatBE

  • writeFloatBE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeFloatLE

  • writeFloatLE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeInt16BE

  • writeInt16BE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeInt16LE

  • writeInt16LE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeInt32BE

  • writeInt32BE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeInt32LE

  • writeInt32LE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeInt8

  • writeInt8(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeUInt16LE

  • writeUInt16LE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeUInt32BE

  • writeUInt32BE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeUInt32LE

  • writeUInt32LE(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeUInt8

  • writeUInt8(value: number, offset: number): number
  • Parameters

    • value: number
    • offset: number

    Returns number

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number

    Returns number

Static alloc

  • alloc(size: number, fill?: string | Buffer | number, encoding?: BufferEncoding): Buffer
  • Allocates a new buffer of {size} octets.

    Parameters

    • size: number

      count of octets to allocate.

    • Optional fill: string | Buffer | number

      if specified, buffer will be initialized by calling buf.fill(fill). If parameter is omitted, buffer will be filled with zeros.

    • Optional encoding: BufferEncoding

      encoding used for call to buf.fill while initalizing

    Returns Buffer

Static allocUnsafe

  • allocUnsafe(size: number): Buffer
  • Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.

    Parameters

    • size: number

      count of octets to allocate

    Returns Buffer

Static allocUnsafeSlow

  • allocUnsafeSlow(size: number): Buffer
  • Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents of the newly created Buffer are unknown and may contain sensitive data.

    Parameters

    • size: number

      count of octets to allocate

    Returns Buffer

Static byteLength

  • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

    Parameters

    Returns number

Static compare

  • compare(buf1: Uint8Array, buf2: Uint8Array): number
  • The same as buf1.compare(buf2).

    Parameters

    • buf1: Uint8Array
    • buf2: Uint8Array

    Returns number

Static concat

  • concat(list: Uint8Array[], totalLength?: undefined | number): Buffer
  • Returns a buffer which is the result of concatenating all the buffers in the list together.

    If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

    Parameters

    • list: Uint8Array[]

      An array of Buffer objects to concatenate

    • Optional totalLength: undefined | number

      Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

    Returns Buffer

Static from

  • from(arrayBuffer: ArrayBuffer | SharedArrayBuffer, byteOffset?: undefined | number, length?: undefined | number): Buffer
  • from(data: number[]): Buffer
  • from(data: Uint8Array): Buffer
  • from(str: string, encoding?: BufferEncoding): Buffer
  • When passed a reference to the .buffer property of a TypedArray instance, the newly created Buffer will share the same allocated memory as the TypedArray. The optional {byteOffset} and {length} arguments specify a memory range within the {arrayBuffer} that will be shared by the Buffer.

    Parameters

    • arrayBuffer: ArrayBuffer | SharedArrayBuffer

      The .buffer property of any TypedArray or a new ArrayBuffer()

    • Optional byteOffset: undefined | number
    • Optional length: undefined | number

    Returns Buffer

  • Creates a new Buffer using the passed {data}

    Parameters

    • data: number[]

      data to create a new Buffer

    Returns Buffer

  • Parameters

    • data: Uint8Array

    Returns Buffer

  • Creates a new Buffer containing the given JavaScript string {str}. If provided, the {encoding} parameter identifies the character encoding. If not provided, {encoding} defaults to 'utf8'.

    Parameters

    Returns Buffer

Static isBuffer

  • isBuffer(obj: any): boolean
  • Returns true if {obj} is a Buffer

    Parameters

    • obj: any

      object to test.

    Returns boolean

Static isEncoding

  • isEncoding(encoding: string): boolean
  • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

    Parameters

    • encoding: string

      string to test.

    Returns boolean

Static of

  • of(...items: number[]): Buffer
  • Creates a new Buffer using the passed {data}

    Parameters

    • Rest ...items: number[]

    Returns Buffer

Generated using TypeDoc