External

Interfaces

ArrayIterator

Extends

IteratorObject<T, BuiltinIteratorReturn, unknown>

Type Parameters

Type Parameter
`T`

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

IteratorObject.[dispose]

[iterator]()

[iterator](): ArrayIterator<T>

Returns

ArrayIterator<T>

Overrides

IteratorObject.[iterator]

next()

next(...__namedParameters): IteratorResult<T, undefined>

Parameters

Parameter	Type
...`__namedParameters`	[] \| [`unknown`]

Returns

IteratorResult<T, undefined>

Inherited from

IteratorObject.next

return()?

optional return(value?): IteratorResult<T, undefined>

Parameters

Parameter	Type
`value?`	`undefined`

Returns

IteratorResult<T, undefined>

Inherited from

IteratorObject.return

throw()?

optional throw(e?): IteratorResult<T, undefined>

Parameters

Parameter	Type
`e?`	`any`

Returns

IteratorResult<T, undefined>

Inherited from

IteratorObject.throw

ArrayLike

Type Parameters

Type Parameter
`T`

Indexable

[n: number]: T

Properties

Property	Modifier	Type
`length`	`readonly`	`number`

BigInt64Array

A typed array of 64-bit signed integer values. The contents are initialized to 0. If the requested number of bytes could not be allocated, an exception is raised.

Type Parameters

Type Parameter	Default type
`TArrayBuffer` extends `ArrayBufferLike`	`ArrayBufferLike`

Indexable

[index: number]: bigint

Properties

Property	Modifier	Type	Description
`[toStringTag]`	`readonly`	`"BigInt64Array"`	-
`buffer`	`readonly`	`TArrayBuffer`	The ArrayBuffer instance referenced by the array.
`byteLength`	`readonly`	`number`	The length in bytes of the array.
`byteOffset`	`readonly`	`number`	The offset in bytes of the array.
`BYTES_PER_ELEMENT`	`readonly`	`number`	The size in bytes of each element in the array.
`length`	`readonly`	`number`	The length of the array.

Methods

[iterator]()

[iterator](): ArrayIterator<bigint>

Returns

ArrayIterator<bigint>

copyWithin()

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

Parameter	Type	Description
`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.
`end?`	`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, thisArg?): boolean

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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

fill()

fill(value, start?, end?): this

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

Parameters

Parameter	Type	Description
`value`	`bigint`	value to fill array section with
`start?`	`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.
`end?`	`number`	index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

filter()

filter(predicate, thisArg?): BigInt64Array<ArrayBuffer>

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `any`	A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
`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

BigInt64Array<ArrayBuffer>

find()

find(predicate, thisArg?): bigint | undefined

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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

bigint | undefined

findIndex()

findIndex(predicate, thisArg?): number

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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, thisArg?): void

Performs the specified action for each element in an array.

Parameters

Parameter	Type	Description
`callbackfn`	(`value`, `index`, `array`) => `void`	A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
`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(searchElement, fromIndex?): boolean

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

Parameters

Parameter	Type	Description
`searchElement`	`bigint`	The element to search for.
`fromIndex?`	`number`	The position in this array at which to begin searching for searchElement.

Returns

boolean

indexOf()

indexOf(searchElement, fromIndex?): number

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

Parameters

Parameter	Type	Description
`searchElement`	`bigint`	The value to locate in the array.
`fromIndex?`	`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

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

Parameters

Parameter	Type	Description
`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(): ArrayIterator<number>

Yields each index in the array.

Returns

ArrayIterator<number>

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Returns the index of the last occurrence of a value in an array.

Parameters

Parameter	Type	Description
`searchElement`	`bigint`	The value to locate in the array.
`fromIndex?`	`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, thisArg?): BigInt64Array<ArrayBuffer>

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

Parameters

Parameter	Type	Description
`callbackfn`	(`value`, `index`, `array`) => `bigint`	A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
`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

BigInt64Array<ArrayBuffer>

reduce()

Call Signature

reduce(callbackfn): 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

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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

Call Signature

reduce<U>(callbackfn, initialValue): 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

Type Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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()

Call Signature

reduceRight(callbackfn): 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

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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

Call Signature

reduceRight<U>(callbackfn, initialValue): 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

Type Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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, offset?): void

Sets a value or an array of values.

Parameters

Parameter	Type	Description
`array`	`ArrayLike`<`bigint`>	A typed or untyped array of values to set.
`offset?`	`number`	The index in the current array at which the values are to be written.

Returns

void

slice()

slice(start?, end?): BigInt64Array<ArrayBuffer>

Returns a section of an array.

Parameters

Parameter	Type	Description
`start?`	`number`	The beginning of the specified portion of the array.
`end?`	`number`	The end of the specified portion of the array.

Returns

BigInt64Array<ArrayBuffer>

some()

some(predicate, thisArg?): boolean

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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

sort()

sort(compareFn?): this

Sorts the array.

Parameters

Parameter	Type	Description
`compareFn?`	(`a`, `b`) => `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?, end?): BigInt64Array<TArrayBuffer>

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

Parameters

Parameter	Type	Description
`begin?`	`number`	The index of the beginning of the array.
`end?`	`number`	The index of the end of the array.

Returns

BigInt64Array<TArrayBuffer>

toLocaleString()

toLocaleString(locales?, options?): string

Converts the array to a string by using the current locale.

Parameters

Parameter	Type
`locales?`	`string` \| `string`[]
`options?`	`NumberFormatOptions`

Returns

string

toString()

toString(): string

Returns a string representation of the array.

Returns

string

valueOf()

valueOf(): BigInt64Array<TArrayBuffer>

Returns the primitive value of the specified object.

Returns

BigInt64Array<TArrayBuffer>

values()

values(): ArrayIterator<bigint>

Yields each value in the array.

Returns

ArrayIterator<bigint>

BigInt64ArrayConstructor

Constructors

Constructor

new BigInt64ArrayConstructor(length?): BigInt64Array<ArrayBuffer>

Parameters

Parameter	Type
`length?`	`number`

Returns

BigInt64Array<ArrayBuffer>

Constructor

new BigInt64ArrayConstructor(array): BigInt64Array<ArrayBuffer>

Parameters

Parameter	Type
`array`	`ArrayLike`<`bigint`> \| `Iterable`<`bigint`, `any`, `any`>

Returns

BigInt64Array<ArrayBuffer>

Constructor

new BigInt64ArrayConstructor<TArrayBuffer>(buffer, byteOffset?, length?): BigInt64Array<TArrayBuffer>

Parameters

Parameter	Type
`buffer`	`TArrayBuffer`
`byteOffset?`	`number`
`length?`	`number`

Returns

BigInt64Array<TArrayBuffer>

Constructor

new BigInt64ArrayConstructor(buffer, byteOffset?, length?): BigInt64Array<ArrayBuffer>

Parameters

Parameter	Type
`buffer`	`ArrayBuffer`
`byteOffset?`	`number`
`length?`	`number`

Returns

BigInt64Array<ArrayBuffer>

Constructor

new BigInt64ArrayConstructor(array): BigInt64Array<ArrayBuffer>

Parameters

Parameter	Type
`array`	`ArrayBuffer` \| `ArrayLike`<`bigint`>

Returns

BigInt64Array<ArrayBuffer>

Properties

Property	Modifier	Type	Description
`BYTES_PER_ELEMENT`	`readonly`	`number`	The size in bytes of each element in the array.
`prototype`	`readonly`	`BigInt64Array`<`ArrayBufferLike`>	-

Methods

from()

Call Signature

from(arrayLike): BigInt64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Parameters

Parameter	Type	Description
`arrayLike`	`ArrayLike`<`bigint`>	An array-like object to convert to an array.

Returns

BigInt64Array<ArrayBuffer>

Call Signature

from<U>(arrayLike, mapfn, thisArg?): BigInt64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Type Parameters

Type Parameter
`U`

Parameters

Parameter	Type	Description
`arrayLike`	`ArrayLike`<`U`>	An array-like object to convert to an array.
`mapfn`	(`v`, `k`) => `bigint`	A mapping function to call on every element of the array.
`thisArg?`	`any`	Value of 'this' used to invoke the mapfn.

Returns

BigInt64Array<ArrayBuffer>

Call Signature

from(elements): BigInt64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Parameters

Parameter	Type	Description
`elements`	`Iterable`<`bigint`>	An iterable object to convert to an array.

Returns

BigInt64Array<ArrayBuffer>

Call Signature

from<T>(elements, mapfn?, thisArg?): BigInt64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`elements`	`Iterable`<`T`>	An iterable object to convert to an array.
`mapfn?`	(`v`, `k`) => `bigint`	A mapping function to call on every element of the array.
`thisArg?`	`any`	Value of 'this' used to invoke the mapfn.

Returns

BigInt64Array<ArrayBuffer>

of()

of(...items): BigInt64Array<ArrayBuffer>

Returns a new array from a set of elements.

Parameters

Parameter	Type	Description
...`items`	`bigint`[]	A set of elements to include in the new array object.

Returns

BigInt64Array<ArrayBuffer>

BigUint64Array

A typed array of 64-bit unsigned integer values. The contents are initialized to 0. If the requested number of bytes could not be allocated, an exception is raised.

Type Parameters

Type Parameter	Default type
`TArrayBuffer` extends `ArrayBufferLike`	`ArrayBufferLike`

Indexable

[index: number]: bigint

Properties

Property	Modifier	Type	Description
`[toStringTag]`	`readonly`	`"BigUint64Array"`	-
`buffer`	`readonly`	`TArrayBuffer`	The ArrayBuffer instance referenced by the array.
`byteLength`	`readonly`	`number`	The length in bytes of the array.
`byteOffset`	`readonly`	`number`	The offset in bytes of the array.
`BYTES_PER_ELEMENT`	`readonly`	`number`	The size in bytes of each element in the array.
`length`	`readonly`	`number`	The length of the array.

Methods

[iterator]()

[iterator](): ArrayIterator<bigint>

Returns

ArrayIterator<bigint>

copyWithin()

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

Parameter	Type	Description
`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.
`end?`	`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, thisArg?): boolean

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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

fill()

fill(value, start?, end?): this

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

Parameters

Parameter	Type	Description
`value`	`bigint`	value to fill array section with
`start?`	`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.
`end?`	`number`	index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

filter()

filter(predicate, thisArg?): BigUint64Array<ArrayBuffer>

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `any`	A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.
`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

BigUint64Array<ArrayBuffer>

find()

find(predicate, thisArg?): bigint | undefined

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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

bigint | undefined

findIndex()

findIndex(predicate, thisArg?): number

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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, thisArg?): void

Performs the specified action for each element in an array.

Parameters

Parameter	Type	Description
`callbackfn`	(`value`, `index`, `array`) => `void`	A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
`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(searchElement, fromIndex?): boolean

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

Parameters

Parameter	Type	Description
`searchElement`	`bigint`	The element to search for.
`fromIndex?`	`number`	The position in this array at which to begin searching for searchElement.

Returns

boolean

indexOf()

indexOf(searchElement, fromIndex?): number

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

Parameters

Parameter	Type	Description
`searchElement`	`bigint`	The value to locate in the array.
`fromIndex?`	`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

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

Parameters

Parameter	Type	Description
`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(): ArrayIterator<number>

Yields each index in the array.

Returns

ArrayIterator<number>

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Returns the index of the last occurrence of a value in an array.

Parameters

Parameter	Type	Description
`searchElement`	`bigint`	The value to locate in the array.
`fromIndex?`	`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, thisArg?): BigUint64Array<ArrayBuffer>

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

Parameters

Parameter	Type	Description
`callbackfn`	(`value`, `index`, `array`) => `bigint`	A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
`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

BigUint64Array<ArrayBuffer>

reduce()

Call Signature

reduce(callbackfn): 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

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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

Call Signature

reduce<U>(callbackfn, initialValue): 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

Type Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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()

Call Signature

reduceRight(callbackfn): 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

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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

Call Signature

reduceRight<U>(callbackfn, initialValue): 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

Type Parameter
`U`

Parameters

Parameter	Type	Description
`callbackfn`	(`previousValue`, `currentValue`, `currentIndex`, `array`) => `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, offset?): void

Sets a value or an array of values.

Parameters

Parameter	Type	Description
`array`	`ArrayLike`<`bigint`>	A typed or untyped array of values to set.
`offset?`	`number`	The index in the current array at which the values are to be written.

Returns

void

slice()

slice(start?, end?): BigUint64Array<ArrayBuffer>

Returns a section of an array.

Parameters

Parameter	Type	Description
`start?`	`number`	The beginning of the specified portion of the array.
`end?`	`number`	The end of the specified portion of the array.

Returns

BigUint64Array<ArrayBuffer>

some()

some(predicate, thisArg?): boolean

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

Parameters

Parameter	Type	Description
`predicate`	(`value`, `index`, `array`) => `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.
`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

sort()

sort(compareFn?): this

Sorts the array.

Parameters

Parameter	Type	Description
`compareFn?`	(`a`, `b`) => `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?, end?): 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

Parameter	Type	Description
`begin?`	`number`	The index of the beginning of the array.
`end?`	`number`	The index of the end of the array.

Returns

BigUint64Array<TArrayBuffer>

toLocaleString()

toLocaleString(locales?, options?): string

Converts the array to a string by using the current locale.

Parameters

Parameter	Type
`locales?`	`string` \| `string`[]
`options?`	`NumberFormatOptions`

Returns

string

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>

BigUint64ArrayConstructor

Constructors

Constructor

new BigUint64ArrayConstructor(length?): BigUint64Array<ArrayBuffer>

Parameters

Parameter	Type
`length?`	`number`

Returns

BigUint64Array<ArrayBuffer>

Constructor

new BigUint64ArrayConstructor(array): BigUint64Array<ArrayBuffer>

Parameters

Parameter	Type
`array`	`ArrayLike`<`bigint`> \| `Iterable`<`bigint`, `any`, `any`>

Returns

BigUint64Array<ArrayBuffer>

Constructor

new BigUint64ArrayConstructor<TArrayBuffer>(buffer, byteOffset?, length?): BigUint64Array<TArrayBuffer>

Parameters

Parameter	Type
`buffer`	`TArrayBuffer`
`byteOffset?`	`number`
`length?`	`number`

Returns

BigUint64Array<TArrayBuffer>

Constructor

new BigUint64ArrayConstructor(buffer, byteOffset?, length?): BigUint64Array<ArrayBuffer>

Parameters

Parameter	Type
`buffer`	`ArrayBuffer`
`byteOffset?`	`number`
`length?`	`number`

Returns

BigUint64Array<ArrayBuffer>

Constructor

new BigUint64ArrayConstructor(array): BigUint64Array<ArrayBuffer>

Parameters

Parameter	Type
`array`	`ArrayBuffer` \| `ArrayLike`<`bigint`>

Returns

BigUint64Array<ArrayBuffer>

Properties

Property	Modifier	Type	Description
`BYTES_PER_ELEMENT`	`readonly`	`number`	The size in bytes of each element in the array.
`prototype`	`readonly`	`BigUint64Array`<`ArrayBufferLike`>	-

Methods

from()

Call Signature

from(arrayLike): BigUint64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Parameters

Parameter	Type	Description
`arrayLike`	`ArrayLike`<`bigint`>	An array-like object to convert to an array.

Returns

BigUint64Array<ArrayBuffer>

Call Signature

from<U>(arrayLike, mapfn, thisArg?): BigUint64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Type Parameters

Type Parameter
`U`

Parameters

Parameter	Type	Description
`arrayLike`	`ArrayLike`<`U`>	An array-like object to convert to an array.
`mapfn`	(`v`, `k`) => `bigint`	A mapping function to call on every element of the array.
`thisArg?`	`any`	Value of 'this' used to invoke the mapfn.

Returns

BigUint64Array<ArrayBuffer>

Call Signature

from(elements): BigUint64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Parameters

Parameter	Type	Description
`elements`	`Iterable`<`bigint`>	An iterable object to convert to an array.

Returns

BigUint64Array<ArrayBuffer>

Call Signature

from<T>(elements, mapfn?, thisArg?): BigUint64Array<ArrayBuffer>

Creates an array from an array-like or iterable object.

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type	Description
`elements`	`Iterable`<`T`>	An iterable object to convert to an array.
`mapfn?`	(`v`, `k`) => `bigint`	A mapping function to call on every element of the array.
`thisArg?`	`any`	Value of 'this' used to invoke the mapfn.

Returns

BigUint64Array<ArrayBuffer>

of()

of(...items): BigUint64Array<ArrayBuffer>

Returns a new array from a set of elements.

Parameters

Parameter	Type	Description
...`items`	`bigint`[]	A set of elements to include in the new array object.

Returns

BigUint64Array<ArrayBuffer>

Iterable

Type Parameters

Type Parameter	Default type
`T`	-
`TReturn`	`any`
`TNext`	`any`

Methods

[iterator]()

[iterator](): Iterator<T, TReturn, TNext>

Returns

Iterator<T, TReturn, TNext>

Iterator

Type Parameters

Type Parameter	Default type
`T`	-
`TReturn`	`any`
`TNext`	`any`

Methods

next()

next(...__namedParameters): IteratorResult<T, TReturn>

Parameters

Parameter	Type
...`__namedParameters`	[] \| [`TNext`]

Returns

IteratorResult<T, TReturn>

return()?

optional return(value?): IteratorResult<T, TReturn>

Parameters

Parameter	Type
`value?`	`TReturn`

Returns

IteratorResult<T, TReturn>

throw()?

optional throw(e?): IteratorResult<T, TReturn>

Parameters

Parameter	Type
`e?`	`any`

Returns

IteratorResult<T, TReturn>

IteratorReturnResult

Type Parameters

Type Parameter
`TReturn`

Properties

Property	Type
`done`	`true`
`value`	`TReturn`

IteratorYieldResult

Type Parameters

Type Parameter
`TYield`

Properties

Property	Type
`done?`	`false`
`value`	`TYield`

Type Aliases

ArrayBufferLike

ArrayBufferLike = ArrayBufferTypes[keyof ArrayBufferTypes]

BuiltinIteratorReturn

BuiltinIteratorReturn = intrinsic

Defines the TReturn type used for built-in iterators produced by Array, Map, Set, and others. This is undefined when strictBuiltInIteratorReturn is true; otherwise, this is any.

FileContents

FileContents = { contents: string; fileType: string; name: string; } | { contents: undefined; fileType: undefined; name: undefined; }

The file properties. Either all properties will be set or undefined.

FileCreateOptions

FileCreateOptions = object

Properties

Property	Type	Description
`contents`	`ArrayBuffer` \| `TypedArray` \| `string`	The contents of the File to create. Note that if an ArrayBuffer or TypedArray is used, ownership of its memory will be transferred to another thread, and it will become inaccessible in this thread.
`folderId?`	`number`	The id of the Folder to create the File in. If left undefined, the File will be created in the root Folder.
`name`	`string`	The name of the File to create.

FileUpdateOptions

FileUpdateOptions = object

Properties

Property	Type	Description
`contents?`	`ArrayBuffer` \| `TypedArray` \| `string`	The contents of the File. Note that if an ArrayBuffer or TypedArray is used, ownership of its memory will be transferred to another thread, and it will become inaccessible in this thread.
`name?`	`string`	Update the name of the File.

IteratorResult

IteratorResult<T, TReturn> = IteratorYieldResult<T> | IteratorReturnResult<TReturn>

Type Parameters

Type Parameter	Default type
`T`	-
`TReturn`	`any`

SingleFile

SingleFile = GSBaseEntity & object

Type Declaration

Name	Type
`fileType`	`string`
`folderId?`	`number`
`modifiedDate`	`Date`
`owner?`	`number`
`size`	`number`

TypedArray

TypedArray = Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array | BigInt64Array | BigUint64Array

Variables

BigInt64Array

BigInt64Array: BigInt64ArrayConstructor

BigUint64Array

BigUint64Array: BigUint64ArrayConstructor