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'|'base64url'|'binary'(deprecated)|'hex'

Hierarchy

  • Uint8Array
    • Buffer

Constructors

  • 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: readonly 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

Properties

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

[toStringTag]: "Uint8Array"

The ArrayBuffer instance referenced by the array.

byteLength: number

The length in bytes of the array.

byteOffset: number

The offset in bytes of the array.

length: number

The length of the array.

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

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

  • Returns IterableIterator<number>

  • Parameters

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

    Returns number

  • Parameters

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

    Returns number

  • 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: number

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

    Returns Buffer

  • Returns IterableIterator<[number, number]>

  • Parameters

    • otherBuffer: Uint8Array

    Returns boolean

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

    Parameters

    • predicate: ((value: number, index: number, array: Uint8Array) => unknown)

      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.

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

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

          Returns unknown

    • Optional thisArg: any

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

    Returns boolean

  • Parameters

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

    Returns Buffer

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

    Parameters

    • predicate: ((value: number, index: number, array: Uint8Array) => any)

      A function that accepts up to three arguments. The filter method calls the predicate 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 predicate function. If thisArg is omitted, undefined is used as the this value.

    Returns Uint8Array

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

    Parameters

    • predicate: ((value: number, index: number, obj: Uint8Array) => boolean)

      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 undefined | number

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

    Parameters

    • predicate: ((value: number, index: number, obj: Uint8Array) => boolean)

      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

  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: ((value: number, index: number, array: Uint8Array) => void)

      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

  • Parameters

    Returns boolean

  • Parameters

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

    Returns number

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

    Parameters

    • Optional separator: 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

  • Returns IterableIterator<number>

  • Parameters

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

    Returns number

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

    Parameters

    • callbackfn: ((value: number, index: number, array: Uint8Array) => number)

      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

  • Parameters

    • Optional offset: number

    Returns bigint

  • Parameters

    • Optional offset: number

    Returns bigint

  • Parameters

    • Optional offset: number

    Returns bigint

  • Parameters

    • Optional offset: number

    Returns bigint

  • Alias

    Buffer.readBigUInt64BE

    Since

    v14.10.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns bigint

  • Alias

    Buffer.readBigUInt64LE

    Since

    v14.10.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns bigint

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • Optional offset: number

    Returns number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

  • Parameters

    • offset: number
    • byteLength: number

    Returns number

  • Alias

    Buffer.readUInt16BE

    Since

    v14.9.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns number

  • Alias

    Buffer.readUInt16LE

    Since

    v14.9.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns number

  • Alias

    Buffer.readUInt32BE

    Since

    v14.9.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns number

  • Alias

    Buffer.readUInt32LE

    Since

    v14.9.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns number

  • Alias

    Buffer.readUInt8

    Since

    v14.9.0, v12.19.0

    Parameters

    • Optional offset: number

    Returns number

  • Alias

    Buffer.readUIntBE

    Since

    v14.9.0, v12.19.0

    Parameters

    • offset: number
    • byteLength: number

    Returns number

  • Alias

    Buffer.readUIntLE

    Since

    v14.9.0, v12.19.0

    Parameters

    • offset: number
    • byteLength: 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.

    Parameters

    • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number)

      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: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number)
        • (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: ((previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U)

      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

  • 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: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number)

      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: ((previousValue: number, currentValue: number, currentIndex: number, array: Uint8Array) => number)
        • (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: ((previousValue: U, currentValue: number, currentIndex: number, array: Uint8Array) => U)

      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

  • Returns Buffer

  • Sets a value or an array of values.

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

    • Optional offset: number

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

    Returns void

  • 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: number

      Where the new Buffer will start. Default: 0.

    • Optional end: number

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

    Returns Buffer

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

    Parameters

    • predicate: ((value: number, index: number, array: Uint8Array) => unknown)

      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.

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

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

          Returns unknown

    • Optional thisArg: any

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

    Returns boolean

  • Sorts an array.

    Parameters

    • Optional compareFn: ((a: number, b: number) => number)

      Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

      [11,2,22,1].sort((a, b) => a - b)
      
        • (a: number, b: number): number
        • Parameters

          • a: number
          • b: number

          Returns number

    Returns 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: number

      Where the new Buffer will start. Default: 0.

    • Optional end: number

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

    Returns Buffer

  • Returns Buffer

  • Returns Buffer

  • Returns Buffer

  • Returns {
        data: number[];
        type: "Buffer";
    }

    • data: number[]
    • type: "Buffer"
  • Converts a number to a string by using the current locale.

    Returns string

  • Parameters

    • Optional encoding: BufferEncoding
    • Optional start: number
    • Optional end: number

    Returns string

  • Returns the primitive value of the specified object.

    Returns Uint8Array

  • Returns IterableIterator<number>

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

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

    Returns number

  • Parameters

    • value: bigint
    • Optional offset: number

    Returns number

  • Parameters

    • value: bigint
    • Optional offset: number

    Returns number

  • Parameters

    • value: bigint
    • Optional offset: number

    Returns number

  • Parameters

    • value: bigint
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeBigUInt64BE

    Since

    v14.10.0, v12.19.0

    Parameters

    • value: bigint
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeBigUInt64LE

    Since

    v14.10.0, v12.19.0

    Parameters

    • value: bigint
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

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

    Returns number

  • Parameters

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

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Parameters

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

    Returns number

  • Parameters

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

    Returns number

  • Alias

    Buffer.writeUInt16BE

    Since

    v14.9.0, v12.19.0

    Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeUInt16LE

    Since

    v14.9.0, v12.19.0

    Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeUInt32BE

    Since

    v14.9.0, v12.19.0

    Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeUInt32LE

    Since

    v14.9.0, v12.19.0

    Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeUInt8

    Since

    v14.9.0, v12.19.0

    Parameters

    • value: number
    • Optional offset: number

    Returns number

  • Alias

    Buffer.writeUIntBE

    Since

    v14.9.0, v12.19.0

    Parameters

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

    Returns number

  • Alias

    Buffer.writeUIntLE

    Since

    v14.9.0, v12.19.0

    Parameters

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

    Returns number

  • Allocates a new buffer of {size} octets.

    Parameters

    • size: number

      count of octets to allocate.

    • Optional fill: string | number | Buffer

      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

  • 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

  • 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

  • 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

  • The same as buf1.compare(buf2).

    Parameters

    • buf1: Uint8Array
    • buf2: Uint8Array

    Returns number

  • 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: readonly Uint8Array[]

      An array of Buffer objects to concatenate

    • Optional totalLength: 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

  • 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

    Returns Buffer

  • Creates a new Buffer using the passed {data}

    Parameters

    • data: Uint8Array | readonly number[]

      data to create a new Buffer

    Returns Buffer

  • Parameters

    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

  • Returns true if {obj} is a Buffer

    Parameters

    • obj: any

      object to test.

    Returns obj is Buffer

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

    Parameters

    • encoding: string

      string to test.

    Returns encoding is BufferEncoding

  • Creates a new Buffer using the passed {data}

    Parameters

    • Rest ...items: number[]

    Returns Buffer

Generated using TypeDoc