Skip to content

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

[K: string | number]: any
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.

[key: number]: undefined | boolean
optional [iterator]: boolean;
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;
optional concat: boolean;
optional copyWithin: boolean;
optional entries: boolean;
optional every: boolean;
optional fill: boolean;
optional filter: boolean;
optional find: boolean;
optional findIndex: boolean;
optional flat: boolean;
optional flatMap: boolean;
optional forEach: boolean;
optional includes: boolean;
optional indexOf: boolean;
optional join: boolean;
optional keys: boolean;
optional lastIndexOf: boolean;
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;
optional reduce: boolean;
optional reduceRight: boolean;
optional reverse: boolean;
optional shift: boolean;
optional slice: boolean;
optional some: boolean;
optional sort: boolean;
optional splice: boolean;
optional toLocaleString: boolean;
optional toString: boolean;
optional unshift: boolean;
optional values: boolean;
Array.[unscopables]

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.

Array.length

readonly static [species]: ArrayConstructor;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316

Array.[species]
iterator: ArrayIterator<any>;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

ArrayIterator<any>

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.

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

any

Array.at

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.

ParameterTypeDescription
itemsConcatArray<any>[]Additional arrays and/or items to add to the end of the array.

any[]

Array.concat
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.

ParameterTypeDescription
itemsany[]Additional arrays and/or items to add to the end of the array.

any[]

Array.concat

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

ParameterTypeDescription
targetnumberIf target is negative, it is treated as length+target where length is the length of the array.
startnumberIf start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
end?numberIf not specified, length of the this object is used as its default value.

this

Array.copyWithin

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

ArrayIterator<[number, any]>

Array.entries

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 Parameter
S extends any
ParameterTypeDescription
predicate(value, index, array) => value is SA 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?anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

this is S[]

Array.every
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.

ParameterTypeDescription
predicate(value, index, array) => unknownA 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?anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

boolean

Array.every

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

ParameterTypeDescription
valueanyvalue to fill array section with
start?numberindex 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?numberindex to stop filling the array at. If end is negative, it is treated as length+end.

this

Array.fill

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

ParameterType
callback(el, index, array) => boolean
thisArg?any

Result

Array.filter

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 Parameter
S extends any
ParameterTypeDescription
predicate(value, index, obj) => value is Sfind 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?anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

undefined | S

Array.find
find(predicate, thisArg?): any;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30

ParameterType
predicate(value, index, obj) => unknown
thisArg?any

any

Array.find

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.

ParameterTypeDescription
predicate(value, index, obj) => unknownfind 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?anyIf provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

number

Array.findIndex

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 ParameterDefault type
A-
D extends number1
ParameterTypeDescription
thisA-
depth?DThe maximum recursion depth

FlatArray<A, D>[]

Array.flat

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 ParameterDefault type
U-
Thisundefined
ParameterTypeDescription
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?ThisAn object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

U[]

Array.flatMap

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.

ParameterTypeDescription
callbackfn(value, index, array) => voidA function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
thisArg?anyAn object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

void

Array.forEach

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.

ParameterType
namestring

any


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.

ParameterTypeDescription
searchElementanyThe element to search for.
fromIndex?numberThe position in this array at which to begin searching for searchElement.

boolean

Array.includes

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.

ParameterTypeDescription
searchElementanyThe value to locate in the array.
fromIndex?numberThe array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

number

Array.indexOf

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.

ParameterTypeDescription
separator?stringA 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.

string

Array.join

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

ArrayIterator<number>

Array.keys

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.

ParameterTypeDescription
searchElementanyThe value to locate in the array.
fromIndex?numberThe array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

number

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 ParameterDefault type
T extends unknownany
ParameterType
callback(el, index, array) => T
thisArg?any

T[]

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.

any

Array.pop

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.

ParameterTypeDescription
itemsany[]New elements to add to the array.

number

Array.push

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.

ParameterTypeDescription
callbackfn(previousValue, currentValue, currentIndex, array) => anyA function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

any

Array.reduce
reduce(callbackfn, initialValue): any;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1489

ParameterType
callbackfn(previousValue, currentValue, currentIndex, array) => any
initialValueany

any

Array.reduce
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 Parameter
U
ParameterTypeDescription
callbackfn(previousValue, currentValue, currentIndex, array) => UA function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
initialValueUIf 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.

U

Array.reduce

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.

ParameterTypeDescription
callbackfn(previousValue, currentValue, currentIndex, array) => anyA function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

any

Array.reduceRight
reduceRight(callbackfn, initialValue): any;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1502

ParameterType
callbackfn(previousValue, currentValue, currentIndex, array) => any
initialValueany

any

Array.reduceRight
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 Parameter
U
ParameterTypeDescription
callbackfn(previousValue, currentValue, currentIndex, array) => UA function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
initialValueUIf 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.

U

Array.reduceRight

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.

any[]

Array.reverse

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.

any

Array.shift

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

ParameterType
start?number
end?number

Result

Array.slice

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.

ParameterTypeDescription
predicate(value, index, array) => unknownA 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?anyAn object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

boolean

Array.some

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.

ParameterTypeDescription
compareFn?(a, b) => numberFunction 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)

this

Array.sort

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.

ParameterTypeDescription
startnumberThe zero-based location in the array from which to start removing elements.
deleteCount?numberThe 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.

any[]

An array containing the elements that were deleted.

Array.splice
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.

ParameterTypeDescription
startnumberThe zero-based location in the array from which to start removing elements.
deleteCountnumberThe 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.
itemsany[]Elements to insert into the array in place of the deleted elements.

any[]

An array containing the elements that were deleted.

Array.splice

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.

ParameterType
deep?boolean

any[]


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.

string

Array.toLocaleString
toLocaleString(locales, options?): string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:64

ParameterType
localesstring | string[]
options?NumberFormatOptions & DateTimeFormatOptions

string

Array.toLocaleString

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.

ParameterType
deep?boolean

Record<string, any>


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.

string

Array.toString

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.

ParameterTypeDescription
itemsany[]Elements to insert at the start of the array.

number

Array.unshift

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

ArrayIterator<any>

Array.values

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 Parameter
T
ParameterTypeDescription
arrayLikeArrayLike<T>An array-like object to convert to an array.

T[]

Array.from
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 Parameter
T
U
ParameterTypeDescription
arrayLikeArrayLike<T>An array-like object to convert to an array.
mapfn(v, k) => UA mapping function to call on every element of the array.
thisArg?anyValue of ‘this’ used to invoke the mapfn.

U[]

Array.from
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 Parameter
T
ParameterTypeDescription
iterable| Iterable<T, any, any> | ArrayLike<T>An iterable object to convert to an array.

T[]

Array.from
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 Parameter
T
U
ParameterTypeDescription
iterable| Iterable<T, any, any> | ArrayLike<T>An iterable object to convert to an array.
mapfn(v, k) => UA mapping function to call on every element of the array.
thisArg?anyValue of ‘this’ used to invoke the mapfn.

U[]

Array.from

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%%.

ParameterType
itemsany[]
keys?(null | string)[]

Result


static isArray(arg): arg is any[];

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1520

ParameterType
argany

arg is any[]

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 Parameter
T
ParameterTypeDescription
itemsT[]A set of elements to include in the new array object.

T[]

Array.of