@cyberchain/smart-contract-wrapper
@cyberchain/smart-contract-wrapper / Result
Defined in: node_modules/@asanrom/ethers-abi/dist/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
Array<any>
[K: string | number]: any
readonly[unscopables]:object
Defined in: 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]: boolean
optional[iterator]:boolean
readonlyoptional[unscopables]:boolean
Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
optionalconcat:boolean
optionalcopyWithin:boolean
optionalentries:boolean
optionalevery:boolean
optionalfill:boolean
optionalfilter:boolean
optionalfind:boolean
optionalfindIndex:boolean
optionalflat:boolean
optionalflatMap:boolean
optionalforEach:boolean
optionalincludes:boolean
optionalindexOf:boolean
optionaljoin:boolean
optionalkeys:boolean
optionallastIndexOf:boolean
optionallength:boolean
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
optionalmap:boolean
optionalpop:boolean
optionalpush:boolean
optionalreduce:boolean
optionalreduceRight:boolean
optionalreverse:boolean
optionalshift:boolean
optionalslice:boolean
optionalsome:boolean
optionalsort:boolean
optionalsplice:boolean
optionaltoLocaleString:boolean
optionaltoString:boolean
optionalunshift:boolean
optionalvalues:boolean
Array.[unscopables]
length:
number
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1325
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
Array.length
readonlystatic[species]:ArrayConstructor
Defined in: node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316
Array.[species]
[iterator]():
IterableIterator<any>
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:58
Iterator
IterableIterator<any>
Array.[iterator]
concat(...
items):any[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1349
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
...ConcatArray<any>[]
Additional arrays and/or items to add to the end of the array.
any[]
Array.concat
concat(...
items):any[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1355
Combines two or more arrays. This method returns a new array without modifying any existing arrays.
...any[]
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/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
number
If target is negative, it is treated as length+target where length is the length of the array.
number
If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
number
If not specified, length of the this object is used as its default value.
this
Array.copyWithin
entries():
IterableIterator<[number,any]>
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:63
Returns an iterable of key, value pairs for every entry in the array
IterableIterator<[number, any]>
Array.entries
every<
S>(predicate,thisArg?):this is S[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1432
Determines whether all the members of an array satisfy the specified test.
S extends any
(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.
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.
this is S[]
Array.every
every(
predicate,thisArg?):boolean
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1441
Determines whether all the members of an array satisfy the specified test.
(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.
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.
boolean
Array.every
fill(
value,start?,end?):this
Defined in: 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
any
value to fill array section with
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.
number
index 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/@asanrom/ethers-abi/dist/abi/coders/abstract-coder.d.ts:44
@_ignore
(el, index, array) => boolean
any
Result
Array.filter
find<
S>(predicate,thisArg?):S
Defined in: 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.
S extends any
(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.
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.
S
Array.find
find(
predicate,thisArg?):any
Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:30
(value, index, obj) => unknown
any
any
Array.find
findIndex(
predicate,thisArg?):number
Defined in: 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.
(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.
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.
number
Array.findIndex
flat<
A,D>(this,depth?):FlatArray<A,D>[]
Defined in: 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.
A
D extends number = 1
A
D
The maximum recursion depth
FlatArray<A, D>[]
Array.flat
flatMap<
U,This>(callback,thisArg?):U[]
Defined in: 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.
U
This = undefined
(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.
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.
U[]
Array.flatMap
forEach(
callbackfn,thisArg?):void
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1456
Performs the specified action for each element in an array.
(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.
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.
void
Array.forEach
getValue(
name):any
Defined in: node_modules/@asanrom/ethers-abi/dist/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.
string
any
includes(
searchElement,fromIndex?):boolean
Defined in: 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.
any
The element to search for.
number
The position in this array at which to begin searching for searchElement.
boolean
Array.includes
indexOf(
searchElement,fromIndex?):number
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1417
Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
any
The value to locate in the array.
number
The 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/typescript/lib/lib.es5.d.ts:1360
Adds all the elements of an array into a string, separated by the specified separator string.
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.
string
Array.join
keys():
IterableIterator<number>
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:68
Returns an iterable of keys in the array
IterableIterator<number>
Array.keys
lastIndexOf(
searchElement,fromIndex?):number
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1423
Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
any
The value to locate in the array.
number
The 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(
callback,thisArg?):any[]
Defined in: node_modules/@asanrom/ethers-abi/dist/abi/coders/abstract-coder.d.ts:48
@_ignore
(el, index, array) => any
any
any[]
Array.map
pop():
any
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1338
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/typescript/lib/lib.es5.d.ts:1343
Appends new elements to the end of an array, and returns the new length of the array.
...any[]
New elements to add to the array.
number
Array.push
reduce(
callbackfn):any
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1480
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.
(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.
any
Array.reduce
reduce(
callbackfn,initialValue):any
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1481
(previousValue, currentValue, currentIndex, array) => any
any
any
Array.reduce
reduce<
U>(callbackfn,initialValue):U
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1487
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.
U
(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.
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.
U
Array.reduce
reduceRight(
callbackfn):any
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1493
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.
(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.
any
Array.reduceRight
reduceRight(
callbackfn,initialValue):any
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1494
(previousValue, currentValue, currentIndex, array) => any
any
any
Array.reduceRight
reduceRight<
U>(callbackfn,initialValue):U
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1500
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.
U
(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.
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.
U
Array.reduceRight
reverse():
any[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1365
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/typescript/lib/lib.es5.d.ts:1370
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/@asanrom/ethers-abi/dist/abi/coders/abstract-coder.d.ts:40
@_ignore
number
number
Result
Array.slice
some(
predicate,thisArg?):boolean
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1450
Determines whether the specified callback function returns true for any element of an array.
(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.
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.
boolean
Array.some
sort(
compareFn?):this
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1391
Sorts an array in place. This method mutates the array and returns a reference to the same array.
(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, ASCII character order.
[11,2,22,1].sort((a, b) => a - b)this
Array.sort
splice(
start,deleteCount?):any[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1398
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
number
The zero-based location in the array from which to start removing elements.
number
The number of elements to remove.
any[]
An array containing the elements that were deleted.
Array.splice
splice(
start,deleteCount, ...items):any[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1406
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
number
The zero-based location in the array from which to start removing elements.
number
The number of elements to remove.
...any[]
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/@asanrom/ethers-abi/dist/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.
boolean
any[]
toLocaleString():
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1333
Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.
string
Array.toLocaleString
toObject(
deep?):Record<string,any>
Defined in: node_modules/@asanrom/ethers-abi/dist/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.
boolean
Record<string, any>
toString():
string
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1329
Returns a string representation of an array.
string
Array.toString
unshift(...
items):number
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1411
Inserts new elements at the start of an array, and returns the new length of the array.
...any[]
Elements to insert at the start of the array.
number
Array.unshift
values():
IterableIterator<any>
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:73
Returns an iterable of values in the array
IterableIterator<any>
Array.values
staticfrom<T>(arrayLike):T[]
Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:70
Creates an array from an array-like object.
T
ArrayLike<T>
An array-like object to convert to an array.
T[]
Array.from
staticfrom<T,U>(arrayLike,mapfn,thisArg?):U[]
Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:78
Creates an array from an iterable object.
T
U
ArrayLike<T>
An array-like object to convert to an array.
(v, k) => U
A mapping function to call on every element of the array.
any
Value of 'this' used to invoke the mapfn.
U[]
Array.from
staticfrom<T>(iterable):T[]
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:81
Creates an array from an iterable object.
T
An iterable object to convert to an array.
Iterable<T> | ArrayLike<T>
T[]
Array.from
staticfrom<T,U>(iterable,mapfn,thisArg?):U[]
Defined in: node_modules/typescript/lib/lib.es2015.iterable.d.ts:89
Creates an array from an iterable object.
T
U
An iterable object to convert to an array.
Iterable<T> | ArrayLike<T>
(v, k) => U
A mapping function to call on every element of the array.
any
Value of 'this' used to invoke the mapfn.
U[]
Array.from
staticfromItems(items,keys?):Result
Defined in: node_modules/@asanrom/ethers-abi/dist/abi/coders/abstract-coder.d.ts:62
Creates a new [[Result]] for %%items%% with each entry also accessible by its corresponding name in %%keys%%.
any[]
string[]
Result
staticisArray(arg):arg is any[]
Defined in: node_modules/typescript/lib/lib.es5.d.ts:1512
any
arg is any[]
Array.isArray
staticof<T>(...items):T[]
Defined in: node_modules/typescript/lib/lib.es2015.core.d.ts:84
Returns a new array from a set of elements.
T
...T[]
A set of elements to include in the new array object.
T[]
Array.of