Interface BigUint64Array<TArrayBuffer>

interface BigUint64Array<TArrayBuffer extends ArrayBufferLike = ArrayBufferLike> {
    "[toStringTag]": "BigUint64Array";
    buffer: TArrayBuffer;
    byteLength: number;
    byteOffset: number;
    BYTES_PER_ELEMENT: number;
    length: number;
    "[iterator]"(): ArrayIterator<bigint>;
    at(index: number): bigint;
    copyWithin(target: number, start: number, end?: number): this;
    entries(): ArrayIterator<[number, bigint]>;
    every(
        predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => boolean,
        thisArg?: any,
    ): boolean;
    fill(value: bigint, start?: number, end?: number): this;
    filter(
        predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => any,
        thisArg?: any,
    ): BigUint64Array<ArrayBuffer>;
    find(
        predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => boolean,
        thisArg?: any,
    ): bigint;
    findIndex(
        predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => boolean,
        thisArg?: any,
    ): number;
    findLast<S extends bigint>(
        predicate: (value: bigint, index: number, array: this) => value is S,
        thisArg?: any,
    ): S;
    findLast(
        predicate: (value: bigint, index: number, array: this) => unknown,
        thisArg?: any,
    ): bigint;
    findLastIndex(
        predicate: (value: bigint, index: number, array: this) => unknown,
        thisArg?: any,
    ): number;
    forEach(
        callbackfn: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => void,
        thisArg?: any,
    ): void;
    includes(searchElement: bigint, fromIndex?: number): boolean;
    indexOf(searchElement: bigint, fromIndex?: number): number;
    join(separator?: string): string;
    keys(): ArrayIterator<number>;
    lastIndexOf(searchElement: bigint, fromIndex?: number): number;
    map(
        callbackfn: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => bigint,
        thisArg?: any,
    ): BigUint64Array<ArrayBuffer>;
    reduce(
        callbackfn: (
            previousValue: bigint,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => bigint,
    ): bigint;
    reduce<U>(
        callbackfn: (
            previousValue: U,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => U,
        initialValue: U,
    ): U;
    reduceRight(
        callbackfn: (
            previousValue: bigint,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => bigint,
    ): bigint;
    reduceRight<U>(
        callbackfn: (
            previousValue: U,
            currentValue: bigint,
            currentIndex: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => U,
        initialValue: U,
    ): U;
    reverse(): this;
    set(array: ArrayLike<bigint>, offset?: number): void;
    slice(start?: number, end?: number): BigUint64Array<ArrayBuffer>;
    some(
        predicate: (
            value: bigint,
            index: number,
            array: BigUint64Array<TArrayBuffer>,
        ) => boolean,
        thisArg?: any,
    ): boolean;
    sort(compareFn?: (a: bigint, b: bigint) => number | bigint): this;
    subarray(begin?: number, end?: number): BigUint64Array<TArrayBuffer>;
    toLocaleString(
        locales?: string | string[],
        options?: NumberFormatOptions,
    ): string;
    toReversed(): BigUint64Array<ArrayBuffer>;
    toSorted(
        compareFn?: (a: bigint, b: bigint) => number,
    ): BigUint64Array<ArrayBuffer>;
    toString(): string;
    valueOf(): BigUint64Array<TArrayBuffer>;
    values(): ArrayIterator<bigint>;
    with(index: number, value: bigint): BigUint64Array<ArrayBuffer>;
    [index: number]: bigint;
}

Type Parameters

TArrayBuffer extends ArrayBufferLike = ArrayBufferLike

Indexable

[index: number]: bigint

Properties

`Readonly`[toStringTag]

"[toStringTag]": "BigUint64Array"

`Readonly`buffer

buffer: TArrayBuffer

The ArrayBuffer instance referenced by the array.

`Readonly`byteLength

byteLength: number

The length in bytes of the array.

`Readonly`byteOffset

byteOffset: number

The offset in bytes of the array.

`Readonly`BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number

The size in bytes of each element in the array.

`Readonly`length

length: number

The length of the array.

Methods

[iterator]

"[iterator]"(): ArrayIterator<bigint>
Returns ArrayIterator<bigint>

at

at(index: number): bigint
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 bigint

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.
- Optionalend: number
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): ArrayIterator<[number, bigint]>
Yields index, value pairs for every entry in the array.

Returns ArrayIterator<[number, bigint]>

every

every(
    predicate: (
        value: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => boolean,
    thisArg?: any,
): boolean
Determines whether all the members of an array satisfy the specified test.
Parameters
- predicate: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => boolean
  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 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

fill

fill(value: bigint, start?: number, end?: number): this
Changes all array elements from start to end index to a static value and returns the modified array
Parameters
- value: bigint
  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

filter

filter(
    predicate: (
        value: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => any,
    thisArg?: any,
): BigUint64Array<ArrayBuffer>
Returns the elements of an array that meet the condition specified in a callback function.
Parameters
- predicate: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => 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 BigUint64Array<ArrayBuffer>

find

find(
    predicate: (
        value: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => boolean,
    thisArg?: any,
): bigint
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Parameters
- predicate: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => 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 bigint

findIndex

findIndex(
    predicate: (
        value: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => boolean,
    thisArg?: any,
): number
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => 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

findLast

findLast<S extends bigint>(
predicate: (value: bigint, index: number, array: this) => value is S,
thisArg?: any,
): S
Returns the value of the last element in the array where predicate is true, and undefined otherwise.
Type Parameters
- S extends bigint
Parameters
- predicate: (value: bigint, index: number, array: this) => value is S
  findLast calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLast immediately returns that element value. Otherwise, findLast 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 S
findLast(
predicate: (value: bigint, index: number, array: this) => unknown,
thisArg?: any,
): bigint
Parameters
- predicate: (value: bigint, index: number, array: this) => unknown
- OptionalthisArg: any
Returns bigint

findLastIndex

findLastIndex(
predicate: (value: bigint, index: number, array: this) => unknown,
thisArg?: any,
): number
Returns the index of the last element in the array where predicate is true, and -1 otherwise.
Parameters
- predicate: (value: bigint, index: number, array: this) => unknown
  findLastIndex calls predicate once for each element of the array, in descending order, until it finds one where predicate returns true. If such an element is found, findLastIndex immediately returns that element index. Otherwise, findLastIndex 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: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => void,
    thisArg?: any,
): void
Performs the specified action for each element in an array.
Parameters
- callbackfn: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => 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: bigint, fromIndex?: number): boolean
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
- searchElement: bigint
  The element to search for.
- OptionalfromIndex: number
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: bigint, fromIndex?: number): number
Returns the index of the first occurrence of a value in an array.
Parameters
- searchElement: bigint
  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>
Yields each index in the array.

Returns ArrayIterator<number>

lastIndexOf

lastIndexOf(searchElement: bigint, fromIndex?: number): number
Returns the index of the last occurrence of a value in an array.
Parameters
- searchElement: bigint
  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: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => bigint,
    thisArg?: any,
): BigUint64Array<ArrayBuffer>
Calls a defined callback function on each element of an array, and returns an array that contains the results.
Parameters
- callbackfn: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => bigint
  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 BigUint64Array<ArrayBuffer>

reduce

reduce(
    callbackfn: (
        previousValue: bigint,
        currentValue: bigint,
        currentIndex: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => bigint,
): bigint
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: bigint,
      currentValue: bigint,
      currentIndex: number,
      array: BigUint64Array<TArrayBuffer>,
  ) => bigint
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
Returns bigint
reduce<U>(
    callbackfn: (
        previousValue: U,
        currentValue: bigint,
        currentIndex: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => 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: bigint,
      currentIndex: number,
      array: BigUint64Array<TArrayBuffer>,
  ) => 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: bigint,
        currentValue: bigint,
        currentIndex: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => bigint,
): bigint
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: bigint,
      currentValue: bigint,
      currentIndex: number,
      array: BigUint64Array<TArrayBuffer>,
  ) => bigint
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
Returns bigint
reduceRight<U>(
    callbackfn: (
        previousValue: U,
        currentValue: bigint,
        currentIndex: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => 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: bigint,
      currentIndex: number,
      array: BigUint64Array<TArrayBuffer>,
  ) => 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

reverse

reverse(): this
Reverses the elements in the array.

Returns this

set

set(array: ArrayLike<bigint>, offset?: number): void
Sets a value or an array of values.
Parameters
- array: ArrayLike<bigint>
  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

slice

slice(start?: number, end?: number): BigUint64Array<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.
Returns BigUint64Array<ArrayBuffer>

some

some(
    predicate: (
        value: bigint,
        index: number,
        array: BigUint64Array<TArrayBuffer>,
    ) => boolean,
    thisArg?: any,
): boolean
Determines whether the specified callback function returns true for any element of an array.
Parameters
- predicate: (value: bigint, index: number, array: BigUint64Array<TArrayBuffer>) => boolean
  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 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

sort

sort(compareFn?: (a: bigint, b: bigint) => number | bigint): this
Sorts the array.
Parameters
- OptionalcompareFn: (a: bigint, b: bigint) => number | bigint
  The function used to determine the order of the elements. If omitted, the elements are sorted in ascending order.
Returns this

subarray

subarray(begin?: number, end?: number): BigUint64Array<TArrayBuffer>
Gets a new BigUint64Array 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 BigUint64Array<TArrayBuffer>

toLocaleString

toLocaleString(
locales?: string | string[],
options?: NumberFormatOptions,
): string
Converts the array to a string by using the current locale.
Parameters
- Optionallocales: string | string[]
- Optionaloptions: NumberFormatOptions
Returns string

toReversed

toReversed(): BigUint64Array<ArrayBuffer>
Copies the array and returns the copy with the elements in reverse order.

Returns BigUint64Array<ArrayBuffer>

toSorted

toSorted(
compareFn?: (a: bigint, b: bigint) => number,
): BigUint64Array<ArrayBuffer>
Copies and sorts the array.
Parameters
- OptionalcompareFn: (a: bigint, b: bigint) => number
  Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending order.
```
const myNums = BigUint64Array<Buffer>.from([11n, 2n, 22n, 1n]);
myNums.toSorted((a, b) => Number(a - b)) // BigUint64Array<Buffer>(4) [1n, 2n, 11n, 22n]
```
Returns BigUint64Array<ArrayBuffer>

toString

toString(): string
Returns a string representation of the array.

Returns string

valueOf

valueOf(): BigUint64Array<TArrayBuffer>
Returns the primitive value of the specified object.

Returns BigUint64Array<TArrayBuffer>

values

values(): ArrayIterator<bigint>
Yields each value in the array.

Returns ArrayIterator<bigint>

with

with(index: number, value: bigint): BigUint64Array<ArrayBuffer>
Copies the array and inserts the given bigint at the provided index.
Parameters
- index: number
  The index of the value to overwrite. If the index is negative, then it replaces from the end of the array.
- value: bigint
  The value to insert into the copied array.
Returns BigUint64Array<ArrayBuffer>
A copy of the original array with the inserted value.

Interface BigUint64Array<TArrayBuffer>

Type Parameters

Indexable

Index

Properties

Methods

Properties

Readonly[toStringTag]

Readonlybuffer

ReadonlybyteLength

ReadonlybyteOffset

ReadonlyBYTES_PER_ELEMENT

Readonlylength

Methods

[iterator]

Returns ArrayIterator<bigint>

at

Parameters

Returns bigint

copyWithin

Parameters

Returns this

entries

Returns ArrayIterator<[number, bigint]>

every

Parameters

Returns boolean

fill

Parameters

Returns this

filter

Parameters

Returns BigUint64Array<ArrayBuffer>

find

Parameters

Returns bigint

findIndex

Parameters

Returns number

findLast

Type Parameters

Parameters

Returns S

Parameters

Returns bigint

findLastIndex

Parameters

Returns number

forEach

Parameters

Returns void

includes

Parameters

Returns boolean

indexOf

Parameters

Returns number

join

Parameters

Returns string

keys

Returns ArrayIterator<number>

lastIndexOf

Parameters

Returns number

map

Parameters

Returns BigUint64Array<ArrayBuffer>

reduce

Parameters

Returns bigint

Type Parameters

Parameters

Returns U

reduceRight

Parameters

Returns bigint

Type Parameters

Parameters

Returns U

`Readonly`[toStringTag]

`Readonly`buffer

`Readonly`byteLength

`Readonly`byteOffset

`Readonly`BYTES_PER_ELEMENT

`Readonly`length