interface Uint8Array {
    BYTES_PER_ELEMENT: number;
    [toStringTag]: "Uint8Array";
    buffer: ArrayBufferLike;
    byteLength: number;
    byteOffset: number;
    length: number;
    [iterator](): IterableIterator<number>;
    at(index: number): undefined | number;
    copyWithin(target: number, start: number, end?: number): this;
    entries(): IterableIterator<[number, number]>;
    every(predicate: ((value: number, index: number, array: Uint8Array) => unknown), thisArg?: any): boolean;
    fill(value: number, start?: number, end?: number): this;
    filter(predicate: ((value: number, index: number, array: Uint8Array) => any), thisArg?: any): Uint8Array;
    find(predicate: ((value: number, index: number, obj: Uint8Array) => boolean), thisArg?: any): undefined | number;
    findIndex(predicate: ((value: number, index: number, obj: Uint8Array) => boolean), thisArg?: any): number;
    forEach(callbackfn: ((value: number, index: number, array: Uint8Array) => void), thisArg?: any): void;
    includes(searchElement: number, fromIndex?: number): boolean;
    indexOf(searchElement: number, fromIndex?: number): number;
    join(separator?: string): string;
    keys(): IterableIterator<number>;
    lastIndexOf(searchElement: number, fromIndex?: number): number;
    map(callbackfn: ((value: number, index: number, array: Uint8Array) => number), thisArg?: any): Uint8Array;
    reduce<T>(callbackfn: reduceCallbackFn<T>, initialValue?: T): T;
    reduceRight<T>(callbackfn: reduceCallbackFn<T>, initialValue?: T): T;
    reverse(): Uint8Array;
    set(array: ArrayLike<number>, offset?: number): void;
    slice(start?: number, end?: number): Uint8Array;
    some(predicate: ((value: number, index: number, array: Uint8Array) => unknown), thisArg?: any): boolean;
    sort(compareFn?: ((a: number, b: number) => number)): this;
    subarray(begin?: number, end?: number): Uint8Array;
    toLocaleString(): string;
    toString(): string;
    valueOf(): Uint8Array;
    values(): IterableIterator<number>;
    [index: number]: number;
}

Hierarchy (view full)

Indexable

  • [index: number]: number

    The index operator [index] can be used to get and set the octet at position index in this. The values refer to individual bytes, so the legal value range is between 0x00 and 0xFF (hex) or 0 and 255 (decimal).

    This operator is inherited from Uint8Array, so its behavior on out-of-bounds access is the same as Uint8Array. In other words, this[index] returns undefined when index is negative or greater or equal to this.length, and buf[index] = value does not modify the buffer if index is negative or >= buf.length.

Properties

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

[toStringTag]: "Uint8Array"

The ArrayBuffer instance referenced by the array.

This ArrayBuffer is not guaranteed to correspond exactly to the original Buffer. See the notes on buf.byteOffset for details.

byteLength: number

The length in bytes of the array.

byteOffset: number

The byteOffset of the Buffers underlying ArrayBuffer object.

When setting byteOffset in Buffer.from(ArrayBuffer, byteOffset, length), or sometimes when allocating a Buffer smaller than Buffer.poolSize, the buffer does not start from a zero offset on the underlying ArrayBuffer.

This can cause problems when accessing the underlying ArrayBuffer directly using buf.buffer, as other parts of the ArrayBuffer may be unrelated to the Buffer object itself.

length: number

Returns the number of bytes in buf.

Methods

  • Returns the item located at the specified index.

    Parameters

    • index: number

      The zero-based index of the desired code unit. A negative index will count back from the last item.

    Returns undefined | 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.

    • Optionalend: number

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

    Returns this

  • 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, index, array): unknown
        • Parameters

          Returns unknown

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

  • Changes all array elements from start to end index to a static value and returns the modified array

    Parameters

    • value: number

      value to fill array section with

    • Optionalstart: number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optionalend: number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

  • 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, index, array): any
        • Parameters

          Returns any

    • OptionalthisArg: 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, index, obj): boolean
        • Parameters

          Returns boolean

    • OptionalthisArg: 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, index, obj): boolean
        • Parameters

          Returns boolean

    • OptionalthisArg: 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, index, array): void
        • Parameters

          Returns void

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

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: number

      The element to search for.

    • OptionalfromIndex: number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

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

    Parameters

    • searchElement: number

      The value to locate in the array.

    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

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

    Parameters

    • Optionalseparator: 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 the index of the last occurrence of a value in an array.

    Parameters

    • searchElement: number

      The value to locate in the array.

    • OptionalfromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    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, index, array): number
        • Parameters

          Returns number

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

  • 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

    • T = number

    Parameters

    • callbackfn: reduceCallbackFn<T>

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

    • OptionalinitialValue: T

      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 T

  • 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

    • T = number

    Parameters

    • callbackfn: reduceCallbackFn<T>

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

    • OptionalinitialValue: T

      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 T

  • Sets a value or an array of values.

    Parameters

    • array: ArrayLike<number>

      A typed or untyped array of values to set.

    • Optionaloffset: number

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

    Returns void

  • Returns a section of an array.

    Parameters

    • Optionalstart: number

      The beginning of the specified portion of the array.

    • Optionalend: number

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

    Returns Uint8Array

  • 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, index, array): unknown
        • Parameters

          Returns unknown

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

    • OptionalcompareFn: ((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, b): number
        • Parameters

          • a: number
          • b: number

          Returns number

    Returns this

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

    Parameters

    • Optionalbegin: number

      The index of the beginning of the array.

    • Optionalend: number

      The index of the end of the array.

    Returns Uint8Array

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

    Returns string

  • Returns a string representation of an array.

    Returns string