Interface ReadonlyUint8Array

Construct a type with the properties of T except for those in type K.

interface ReadonlyUint8Array {
    "[toStringTag]": "Uint8Array";
    buffer: ArrayBufferLike;
    byteLength: number;
    byteOffset: number;
    BYTES_PER_ELEMENT: number;
    length: number;
    "[iterator]"(): ArrayIterator<number>;
    at(index: number): undefined | number;
    entries(): ArrayIterator<[number, number]>;
    every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean;
    filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Uint8Array<ArrayBuffer>;
    find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): undefined | number;
    findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): number;
    forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void;
    includes(searchElement: number, fromIndex?: number): boolean;
    indexOf(searchElement: number, fromIndex?: number): number;
    join(separator?: string): string;
    keys(): ArrayIterator<number>;
    lastIndexOf(searchElement: number, fromIndex?: number): number;
    map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Uint8Array<ArrayBuffer>;
    reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number;
    reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number;
    reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U;
    reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
    ): number;
    reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number;
    reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => U,
        initialValue: U,
    ): U;
    slice(start?: number, end?: number): Uint8Array<ArrayBuffer>;
    some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean;
    subarray(begin?: number, end?: number): Uint8Array<ArrayBufferLike>;
    toLocaleString(): string;
    toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string;
    toString(): string;
    valueOf(): this;
    values(): ArrayIterator<number>;
    readonly [n: number]: number;
}

Hierarchy (View Summary)

Indexable

  • readonly [n: number]: number

Properties

[toStringTag] buffer byteLength byteOffset BYTES_PER_ELEMENT length

Methods

[iterator] at entries every filter find findIndex forEach includes indexOf join keys lastIndexOf map reduce reduceRight slice some subarray toLocaleString toString valueOf values

Properties

Readonly[toStringTag]

"[toStringTag]": "Uint8Array"

Readonlybuffer

buffer: ArrayBufferLike

The ArrayBuffer instance referenced by the array.

ReadonlybyteLength

byteLength: number

The length in bytes of the array.

ReadonlybyteOffset

byteOffset: number

The offset in bytes of the array.

ReadonlyBYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

Readonlylength

length: number

The length of the array.

Methods

[iterator]

  • "[iterator]"(): ArrayIterator<number>

  • Returns ArrayIterator<number>

at

  • at(index: number): undefined | number

  • Parameters

    • index: number

    Returns undefined | number

entries

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

  • Returns an array of key, value pairs for every entry in the array

    Returns ArrayIterator<[number, number]>

every

  • every(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

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

    Parameters

    • predicate: (value: number, index: number, array: this) => 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.

    • 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

filter

  • filter(
        predicate: (value: number, index: number, array: this) => any,
        thisArg?: any,
    ): Uint8Array<ArrayBuffer>

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

    Parameters

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

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

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

find

  • find(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): undefined | number

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

    Parameters

    • predicate: (value: number, index: number, obj: this) => 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.

    • 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

findIndex

  • findIndex(
        predicate: (value: number, index: number, obj: this) => boolean,
        thisArg?: any,
    ): 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: this) => 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.

    • 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

forEach

  • forEach(
        callbackfn: (value: number, index: number, array: this) => void,
        thisArg?: any,
    ): void

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

    Parameters

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

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

    • 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

includes

  • includes(searchElement: number, fromIndex?: number): boolean

  • 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

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number

  • 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

join

  • join(separator?: string): string

  • 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

keys

  • keys(): ArrayIterator<number>

  • Returns an list of keys in the array

    Returns ArrayIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number

  • 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

map

  • map(
        callbackfn: (value: number, index: number, array: this) => number,
        thisArg?: any,
    ): Uint8Array<ArrayBuffer>

  • 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: this) => number

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

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

reduce

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

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

    Returns number

  • reduce(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

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

    Returns number

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

    Type Parameters

    • U

    Parameters

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

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

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

    Parameters

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

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

    Returns number

  • reduceRight(
        callbackfn: (
            previousValue: number,
            currentValue: number,
            currentIndex: number,
            array: this,
        ) => number,
        initialValue: number,
    ): number

  • Parameters

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

    Returns number

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

    Type Parameters

    • U

    Parameters

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

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

    • 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

slice

  • slice(start?: number, end?: number): Uint8Array<ArrayBuffer>

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

some

  • some(
        predicate: (value: number, index: number, array: this) => unknown,
        thisArg?: any,
    ): boolean

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

    Parameters

    • predicate: (value: number, index: number, array: this) => 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.

    • 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

subarray

  • subarray(begin?: number, end?: number): Uint8Array<ArrayBufferLike>

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

toLocaleString

  • toLocaleString(): string

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

    Returns string

  • toLocaleString(
        locales: string | string[],
        options?: NumberFormatOptions,
    ): string

  • Parameters

    • locales: string | string[]
    • Optionaloptions: NumberFormatOptions

    Returns string

toString

  • toString(): string

  • Returns a string representation of an array.

    Returns string

valueOf

  • valueOf(): this

  • Returns the primitive value of the specified object.

    Returns this

values

  • values(): ArrayIterator<number>

  • Returns an list of values in the array

    Returns ArrayIterator<number>

Settings

Member Visibility

On This Page

Properties
Methods