Buffer | typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Buffer

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

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

Methods

Properties

BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

__@toStringTag

__@toStringTag: "UInt8Array"

buffer

buffer: ArrayBufferLike

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.

length

length: number

The length of the array.

Methods

__@iterator

  • __@iterator(): IterableIterator<number>

  • Returns IterableIterator<number>

compare

  • compare(otherBuffer: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number

  • Parameters

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

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number

  • Parameters

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

    Returns number

copyWithin

  • copyWithin(target: number, start: number, end?: 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: number

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

    Returns this

entries

  • entries(): IterableIterator<[number, number]>

  • Returns IterableIterator<[number, number]>

equals

  • equals(otherBuffer: Buffer): boolean

  • Parameters

    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: any, offset?: number, end?: number): this

  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    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?: number, encoding?: string): boolean

  • Parameters

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

    Returns boolean

indexOf

  • indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number

  • Parameters

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

    Returns number

join

  • join(separator?: string): string

  • 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

keys

  • keys(): IterableIterator<number>

  • Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number

  • Parameters

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

    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, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    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(): Uint8Array

  • Reverses the elements in an Array.

    Returns Uint8Array

set

  • set(array: ArrayLike<number>, offset?: 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: number

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

    Returns void

slice

  • slice(start?: number, end?: number): Buffer

  • Parameters

    • Optional start: number
    • Optional end: number

    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?: function): this

  • Sorts an array.

    Parameters

    • Optional compareFn: 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.

        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns this

subarray

  • subarray(begin: number, end?: number): Uint8Array

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

    Parameters

    • begin: number

      The index of the beginning of the array.

    • Optional end: number

      The index of the end of the array.

    Returns Uint8Array

swap16

  • Returns Buffer

swap32

  • Returns Buffer

swap64

  • Returns Buffer

toJSON

  • toJSON(): object

  • Returns object

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

toLocaleString

  • toLocaleString(): string

  • Converts a number to a string by using the current locale.

    Returns string

toString

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

  • Parameters

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

    Returns string

values

  • values(): IterableIterator<number>

  • Returns IterableIterator<number>

write

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

  • Parameters

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

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns number

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number

  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc