Result
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:13
A [[Result]] is a sub-class of Array, which allows accessing any of its values either positionally by its index or, if keys are provided by its name.
@_docloc: api/abi
Extends
Section titled “Extends”Array
<any
>
Indexable
Section titled “Indexable”[K: string | number]: any
Properties
Section titled “Properties”[unscopables]
Section titled “[unscopables]”readonly [unscopables]: object;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97
Is an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.
Index Signature
Section titled “Index Signature”[key: number]: undefined | boolean
[iterator]?
Section titled “[iterator]?”optional [iterator]: boolean;
[unscopables]?
Section titled “[unscopables]?”readonly optional [unscopables]: boolean;
Is an object whose properties have the value ‘true’ when they will be absent when used in a ‘with’ statement.
optional at: boolean;
concat?
Section titled “concat?”optional concat: boolean;
copyWithin?
Section titled “copyWithin?”optional copyWithin: boolean;
entries?
Section titled “entries?”optional entries: boolean;
every?
Section titled “every?”optional every: boolean;
optional fill: boolean;
filter?
Section titled “filter?”optional filter: boolean;
optional find: boolean;
findIndex?
Section titled “findIndex?”optional findIndex: boolean;
optional flat: boolean;
flatMap?
Section titled “flatMap?”optional flatMap: boolean;
forEach?
Section titled “forEach?”optional forEach: boolean;
includes?
Section titled “includes?”optional includes: boolean;
indexOf?
Section titled “indexOf?”optional indexOf: boolean;
optional join: boolean;
optional keys: boolean;
lastIndexOf?
Section titled “lastIndexOf?”optional lastIndexOf: boolean;
length?
Section titled “length?”optional length: boolean;
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
optional map: boolean;
optional pop: boolean;
optional push: boolean;
reduce?
Section titled “reduce?”optional reduce: boolean;
reduceRight?
Section titled “reduceRight?”optional reduceRight: boolean;
reverse?
Section titled “reverse?”optional reverse: boolean;
shift?
Section titled “shift?”optional shift: boolean;
slice?
Section titled “slice?”optional slice: boolean;
optional some: boolean;
optional sort: boolean;
splice?
Section titled “splice?”optional splice: boolean;
toLocaleString?
Section titled “toLocaleString?”optional toLocaleString: boolean;
toString?
Section titled “toString?”optional toString: boolean;
unshift?
Section titled “unshift?”optional unshift: boolean;
values?
Section titled “values?”optional values: boolean;
Inherited from
Section titled “Inherited from”Array.[unscopables]
length
Section titled “length”length: number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1329
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
Inherited from
Section titled “Inherited from”Array.length
[species]
Section titled “[species]”readonly static [species]: ArrayConstructor;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
Inherited from
Section titled “Inherited from”Array.[species]
Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”iterator: ArrayIterator<any>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78
Iterator
Returns
Section titled “Returns”ArrayIterator
<any
>
Inherited from
Section titled “Inherited from”Array.[iterator]
at(index): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24
Returns the item located at the specified index.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
index | number | The zero-based index of the desired code unit. A negative index will count back from the last item. |
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.at
concat()
Section titled “concat()”Call Signature
Section titled “Call Signature”concat(...items): any[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1353
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
…items | ConcatArray <any >[] | Additional arrays and/or items to add to the end of the array. |
Returns
Section titled “Returns”any
[]
Inherited from
Section titled “Inherited from”Array.concat
Call Signature
Section titled “Call Signature”concat(...items): any[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1359
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
…items | any [] | Additional arrays and/or items to add to the end of the array. |
Returns
Section titled “Returns”any
[]
Inherited from
Section titled “Inherited from”Array.concat
copyWithin()
Section titled “copyWithin()”copyWithin( target, start, end?): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62
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
Section titled “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
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Array.copyWithin
entries()
Section titled “entries()”entries(): ArrayIterator<[number, any]>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83
Returns an iterable of key, value pairs for every entry in the array
Returns
Section titled “Returns”ArrayIterator
<[number
, any
]>
Inherited from
Section titled “Inherited from”Array.entries
every()
Section titled “every()”Call Signature
Section titled “Call Signature”every<S>(predicate, thisArg?): this is S[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1440
Determines whether all the members of an array satisfy the specified test.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
S extends any |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
predicate | (value , index , array ) => value is S | 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. |
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
Section titled “Returns”this is S[]
Inherited from
Section titled “Inherited from”Array.every
Call Signature
Section titled “Call Signature”every(predicate, thisArg?): boolean;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1449
Determines whether all the members of an array satisfy the specified test.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
predicate | (value , index , array ) => 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. |
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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Array.every
fill()
Section titled “fill()”fill( value, start?, end?): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51
Changes all array elements from start
to end
index to a static value
and returns the modified array
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
value | any | 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
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Array.fill
filter()
Section titled “filter()”filter(callback, thisArg?): Result;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:44
@_ignore
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
callback | (el , index , array ) => boolean |
thisArg? | any |
Returns
Section titled “Returns”Result
Overrides
Section titled “Overrides”Array.filter
find()
Section titled “find()”Call Signature
Section titled “Call Signature”find<S>(predicate, thisArg?): undefined | S;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
S extends any |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
predicate | (value , index , obj ) => value is S | 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
Section titled “Returns”undefined
| S
Inherited from
Section titled “Inherited from”Array.find
Call Signature
Section titled “Call Signature”find(predicate, thisArg?): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
predicate | (value , index , obj ) => unknown |
thisArg? | any |
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.find
findIndex()
Section titled “findIndex()”findIndex(predicate, thisArg?): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
predicate | (value , index , obj ) => unknown | 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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Array.findIndex
flat()
Section titled “flat()”flat<A, D>(this, depth?): FlatArray<A, D>[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts:75
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type Parameters
Section titled “Type Parameters”Type Parameter | Default type |
---|---|
A | - |
D extends number | 1 |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
this | A | - |
depth? | D | The maximum recursion depth |
Returns
Section titled “Returns”FlatArray
<A
, D
>[]
Inherited from
Section titled “Inherited from”Array.flat
flatMap()
Section titled “flatMap()”flatMap<U, This>(callback, thisArg?): U[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts:64
Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.
Type Parameters
Section titled “Type Parameters”Type Parameter | Default type |
---|---|
U | - |
This | undefined |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
callback | (this , value , index , array ) => U | readonly U [] | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. |
thisArg? | This | An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value. |
Returns
Section titled “Returns”U
[]
Inherited from
Section titled “Inherited from”Array.flatMap
forEach()
Section titled “forEach()”forEach(callbackfn, thisArg?): void;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1464
Performs the specified action for each element in an array.
Parameters
Section titled “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
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Array.forEach
getValue()
Section titled “getValue()”getValue(name): any;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:57
Returns the value for %%name%%.
Since it is possible to have a key whose name conflicts with a method on a [[Result]] or its superclass Array, or any JavaScript keyword, this ensures all named values are still accessible by name.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
name | string |
Returns
Section titled “Returns”any
includes()
Section titled “includes()”includes(searchElement, fromIndex?): boolean;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
searchElement | any | The element to search for. |
fromIndex? | number | The position in this array at which to begin searching for searchElement. |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Array.includes
indexOf()
Section titled “indexOf()”indexOf(searchElement, fromIndex?): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1425
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
searchElement | any | 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
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Array.indexOf
join()
Section titled “join()”join(separator?): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1364
Adds all the elements of an array into a string, separated by the specified separator string.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
separator? | string | A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma. |
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Array.join
keys()
Section titled “keys()”keys(): ArrayIterator<number>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:88
Returns an iterable of keys in the array
Returns
Section titled “Returns”ArrayIterator
<number
>
Inherited from
Section titled “Inherited from”Array.keys
lastIndexOf()
Section titled “lastIndexOf()”lastIndexOf(searchElement, fromIndex?): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1431
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
searchElement | any | The value to locate in the array. |
fromIndex? | number | The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array. |
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Array.lastIndexOf
map<T>(callback, thisArg?): T[];
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:48
@_ignore
Type Parameters
Section titled “Type Parameters”Type Parameter | Default type |
---|---|
T extends unknown | any |
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
callback | (el , index , array ) => T |
thisArg? | any |
Returns
Section titled “Returns”T
[]
Overrides
Section titled “Overrides”Array.map
pop(): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1342
Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.pop
push()
Section titled “push()”push(...items): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1347
Appends new elements to the end of an array, and returns the new length of the array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
…items | any [] | New elements to add to the array. |
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Array.push
reduce()
Section titled “reduce()”Call Signature
Section titled “Call Signature”reduce(callbackfn): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1488
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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
callbackfn | (previousValue , currentValue , currentIndex , array ) => any | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.reduce
Call Signature
Section titled “Call Signature”reduce(callbackfn, initialValue): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1489
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
callbackfn | (previousValue , currentValue , currentIndex , array ) => any |
initialValue | any |
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.reduce
Call Signature
Section titled “Call Signature”reduce<U>(callbackfn, initialValue): U;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1495
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
Section titled “Type Parameters”Type Parameter |
---|
U |
Parameters
Section titled “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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Array.reduce
reduceRight()
Section titled “reduceRight()”Call Signature
Section titled “Call Signature”reduceRight(callbackfn): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1501
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
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
callbackfn | (previousValue , currentValue , currentIndex , array ) => any | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.reduceRight
Call Signature
Section titled “Call Signature”reduceRight(callbackfn, initialValue): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1502
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
callbackfn | (previousValue , currentValue , currentIndex , array ) => any |
initialValue | any |
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.reduceRight
Call Signature
Section titled “Call Signature”reduceRight<U>(callbackfn, initialValue): U;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1508
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
Section titled “Type Parameters”Type Parameter |
---|
U |
Parameters
Section titled “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
Section titled “Returns”U
Inherited from
Section titled “Inherited from”Array.reduceRight
reverse()
Section titled “reverse()”reverse(): any[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1369
Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
Returns
Section titled “Returns”any
[]
Inherited from
Section titled “Inherited from”Array.reverse
shift()
Section titled “shift()”shift(): any;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1374
Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
Returns
Section titled “Returns”any
Inherited from
Section titled “Inherited from”Array.shift
slice()
Section titled “slice()”slice(start?, end?): Result;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:40
@_ignore
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
start? | number |
end? | number |
Returns
Section titled “Returns”Result
Overrides
Section titled “Overrides”Array.slice
some()
Section titled “some()”some(predicate, thisArg?): boolean;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1458
Determines whether the specified callback function returns true for any element of an array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
predicate | (value , index , array ) => 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. |
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
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”Array.some
sort()
Section titled “sort()”sort(compareFn?): this;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1395
Sorts an array in place. This method mutates the array and returns a reference to the same array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
compareFn? | (a , b ) => 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, UTF-16 code unit order. [11,2,22,1].sort((a, b) => a - b) |
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Array.sort
splice()
Section titled “splice()”Call Signature
Section titled “Call Signature”splice(start, deleteCount?): any[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1404
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
start | number | The zero-based location in the array from which to start removing elements. |
deleteCount? | number | The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. |
Returns
Section titled “Returns”any
[]
An array containing the elements that were deleted.
Inherited from
Section titled “Inherited from”Array.splice
Call Signature
Section titled “Call Signature”splice( start, deleteCount, ... items): any[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1414
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
start | number | The zero-based location in the array from which to start removing elements. |
deleteCount | number | The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements. |
…items | any [] | Elements to insert into the array in place of the deleted elements. |
Returns
Section titled “Returns”any
[]
An array containing the elements that were deleted.
Inherited from
Section titled “Inherited from”Array.splice
toArray()
Section titled “toArray()”toArray(deep?): any[];
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:27
Returns the Result as a normal Array. If %%deep%%, any children which are Result objects are also converted to a normal Array.
This will throw if there are any outstanding deferred errors.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
deep? | boolean |
Returns
Section titled “Returns”any
[]
toLocaleString()
Section titled “toLocaleString()”Call Signature
Section titled “Call Signature”toLocaleString(): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1337
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Array.toLocaleString
Call Signature
Section titled “Call Signature”toLocaleString(locales, options?): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
locales | string | string [] |
options? | NumberFormatOptions & DateTimeFormatOptions |
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Array.toLocaleString
toObject()
Section titled “toObject()”toObject(deep?): Record<string, any>;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:36
Returns the Result as an Object with each name-value pair. If %%deep%%, any children which are Result objects are also converted to an Object.
This will throw if any value is unnamed, or if there are any outstanding deferred errors.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
deep? | boolean |
Returns
Section titled “Returns”Record
<string
, any
>
toString()
Section titled “toString()”toString(): string;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1333
Returns a string representation of an array.
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Array.toString
unshift()
Section titled “unshift()”unshift(...items): number;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1419
Inserts new elements at the start of an array, and returns the new length of the array.
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
…items | any [] | Elements to insert at the start of the array. |
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Array.unshift
values()
Section titled “values()”values(): ArrayIterator<any>;
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:93
Returns an iterable of values in the array
Returns
Section titled “Returns”ArrayIterator
<any
>
Inherited from
Section titled “Inherited from”Array.values
from()
Section titled “from()”Call Signature
Section titled “Call Signature”static from<T>(arrayLike): T[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:72
Creates an array from an array-like object.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
T |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
arrayLike | ArrayLike <T > | An array-like object to convert to an array. |
Returns
Section titled “Returns”T
[]
Inherited from
Section titled “Inherited from”Array.from
Call Signature
Section titled “Call Signature”static from<T, U>( arrayLike, mapfn, thisArg?): U[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:80
Creates an array from an iterable object.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
T |
U |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
arrayLike | ArrayLike <T > | An array-like object to convert to an array. |
mapfn | (v , k ) => U | A mapping function to call on every element of the array. |
thisArg? | any | Value of ‘this’ used to invoke the mapfn. |
Returns
Section titled “Returns”U
[]
Inherited from
Section titled “Inherited from”Array.from
Call Signature
Section titled “Call Signature”static from<T>(iterable): T[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:101
Creates an array from an iterable object.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
T |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
iterable | | Iterable <T , any , any > | ArrayLike <T > | An iterable object to convert to an array. |
Returns
Section titled “Returns”T
[]
Inherited from
Section titled “Inherited from”Array.from
Call Signature
Section titled “Call Signature”static from<T, U>( iterable, mapfn, thisArg?): U[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:109
Creates an array from an iterable object.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
T |
U |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
iterable | | Iterable <T , any , any > | ArrayLike <T > | An iterable object to convert to an array. |
mapfn | (v , k ) => U | A mapping function to call on every element of the array. |
thisArg? | any | Value of ‘this’ used to invoke the mapfn. |
Returns
Section titled “Returns”U
[]
Inherited from
Section titled “Inherited from”Array.from
fromItems()
Section titled “fromItems()”static fromItems(items, keys?): Result;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/coders/abstract-coder.d.ts:62
Creates a new [[Result]] for %%items%% with each entry also accessible by its corresponding name in %%keys%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
items | any [] |
keys? | (null | string )[] |
Returns
Section titled “Returns”Result
isArray()
Section titled “isArray()”static isArray(arg): arg is any[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1520
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
arg | any |
Returns
Section titled “Returns”arg is any[]
Inherited from
Section titled “Inherited from”Array.isArray
static of<T>(...items): T[];
Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:86
Returns a new array from a set of elements.
Type Parameters
Section titled “Type Parameters”Type Parameter |
---|
T |
Parameters
Section titled “Parameters”Parameter | Type | Description |
---|---|---|
…items | T [] | A set of elements to include in the new array object. |
Returns
Section titled “Returns”T
[]
Inherited from
Section titled “Inherited from”Array.of