name: NextAuthority
description: The next authority available as SessionKey
Hierarchy
↳ Tuple
↳ NextAuthority
Implements
Indexable
[n: number]: Codec
Constructors
constructor
⊕ new NextAuthority(value?: Uint8Array | NextAuthorityValue): NextAuthority
Overrides Tuple.constructor
Defined in type/StoredPendingChange.ts:30
Parameters:
| Name | Type |
|---|---|
Optional value | Uint8Array | NextAuthorityValue |
Returns: NextAuthority
Properties
length
● length: number
Inherited from Array.length
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1209
Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.
Accessors
Types
get Types(): Array<string>
Defined in codec/Tuple.ts:75
description: The types definition of the tuple
Returns: Array<string>
encodedLength
get encodedLength(): number
Inherited from Tuple.encodedLength
Defined in codec/Tuple.ts:59
description: The length of the value when encoded as a Uint8Array
Returns: number
index
get index(): U64
Defined in type/StoredPendingChange.ts:38
Returns: U64
isEmpty
get isEmpty(): boolean
Defined in codec/Tuple.ts:68
description: Checks if the value is an empty value
Returns: boolean
sessionKey
get sessionKey(): SessionKey
Defined in type/StoredPendingChange.ts:42
Returns: SessionKey
Methods
__@iterator
▸ __@iterator(): IterableIterator<Codec>
Inherited from Array.[Symbol.iterator]
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator
Returns: IterableIterator<Codec>
__@unscopables
▸ __@unscopables(): object
Inherited from Array.[Symbol.unscopables]
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
Returns: object
concat
▸ concat(...items: ConcatArray<Codec>[]): Codec[]
▸ concat(...items: (T | ConcatArray<T>)[]): Codec[]
Inherited from Array.concat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1231
Combines two or more arrays.
Parameters:
| Name | Type | Description |
|---|---|---|
Rest items | ConcatArray<Codec>[] | Additional items to add to the end of array1. |
Returns: Codec[]
Inherited from Array.concat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1236
Combines two or more arrays.
Parameters:
| Name | Type | Description |
|---|---|---|
Rest items | (T | ConcatArray<T>)[] | Additional items to add to the end of array1. |
Returns: Codec[]
copyWithin
▸ copyWithin(target: number, start: number, end?: undefined | number): this
Inherited from Array.copyWithin
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:64
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:
| Name | 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. |
Optional end | undefined | number | If not specified, length of the this object is used as its default value. |
Returns: this
entries
▸ entries(): IterableIterator<[number, Codec]>
Inherited from Array.entries
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array
Returns: IterableIterator<[number, Codec]>
eq
▸ eq(other?: any): boolean
Defined in codec/Tuple.ts:84
description: Compares the value of the input to see if there is a match
Parameters:
| Name | Type |
|---|---|
Optional other | any |
Returns: boolean
every
▸ every(callbackfn: function, thisArg?: any): boolean
Inherited from Array.every
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1296
Determines whether all the members of an array satisfy the specified test.
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array. |
Optional 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: boolean
fill
▸ fill(value: Codec, start?: undefined | number, end?: undefined | number): this
Inherited from Array.fill
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value
Parameters:
| Name | Type | Description |
|---|---|---|
| value | Codec | value to fill array section with |
Optional start | undefined | 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. |
Optional end | undefined | number | index to stop filling the array at. If end is negative, it is treated as length+end. |
Returns: this
filter
▸ filter(callbackfn: function, thisArg?: any): Array<Codec>
Overrides Array.filter
Defined in codec/Tuple.ts:140
description: Filters the array with the callback
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | The filter function |
Optional thisArg | any | The `this` object to apply the result to |
Returns: Array<Codec>
find
▸ find<S>(predicate: function, thisArg?: any): S | undefined
▸ find(predicate: function, thisArg?: any): Codec | undefined
Inherited from Array.find
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.
Type parameters:
S : Codec
Parameters:
| Name | Type | Description |
|---|---|---|
| predicate | function | 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. |
Optional 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: S | undefined
Inherited from Array.find
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters:
| Name | Type |
|---|---|
| predicate | function |
Optional thisArg | any |
Returns: Codec | undefined
findIndex
▸ findIndex(predicate: function, thisArg?: any): number
Inherited from Array.findIndex
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.
Parameters:
| Name | Type | Description |
|---|---|---|
| predicate | function | 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. |
Optional 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
flat
▸ flat<U>(this: U[][][][][][][][], depth: 7): U[]
▸ flat<U>(this: U[][][][][][][], depth: 6): U[]
▸ flat<U>(this: U[][][][][][], depth: 5): U[]
▸ flat<U>(this: U[][][][][], depth: 4): U[]
▸ flat<U>(this: U[][][][], depth: 3): U[]
▸ flat<U>(this: U[][][], depth: 2): U[]
▸ flat<U>(this: U[][], depth?: undefined | 1): U[]
▸ flat<U>(this: U[], depth: 0): U[]
▸ flat<U>(depth?: undefined | number): any[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:158
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][][][][][][][] | |
| depth | 7 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:166
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][][][][][][] | |
| depth | 6 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:174
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][][][][][] | |
| depth | 5 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:182
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][][][][] | |
| depth | 4 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:190
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][][][] | |
| depth | 3 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:198
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][][] | |
| depth | 2 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:206
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[][] | |
Optional depth | undefined | 1 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:214
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| this | U[] | |
| depth | 0 | The maximum recursion depth |
Returns: U[]
Inherited from Array.flat
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:222
Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. If no depth is provided, flat method defaults to the depth of 1.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
Optional depth | undefined | number | The maximum recursion depth |
Returns: any[]
flatMap
▸ flatMap<U,This>(callback: function, thisArg?: This): U[]
Inherited from Array.flatMap
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.esnext.array.d.ts:147
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:
U
This
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | function | A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array. |
Optional 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: U[]
forEach
▸ forEach(callbackfn: function, thisArg?: any): void
Inherited from Array.forEach
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1308
Performs the specified action for each element in an array.
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. |
Optional 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: Codec, fromIndex?: undefined | number): boolean
Inherited from Array.includes
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.
Parameters:
| Name | Type | Description |
|---|---|---|
| searchElement | Codec | The element to search for. |
Optional fromIndex | undefined | number | The position in this array at which to begin searching for searchElement. |
Returns: boolean
indexOf
▸ indexOf(searchElement: Codec, fromIndex?: undefined | number): number
Inherited from Array.indexOf
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1284
Returns the index of the first occurrence of a value in an array.
Parameters:
| Name | Type | Description |
|---|---|---|
| searchElement | Codec | The value to locate in the array. |
Optional fromIndex | undefined | 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?: undefined | string): string
Inherited from Array.join
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1241
Adds all the elements of an array separated by the specified separator string.
Parameters:
| Name | Type | Description |
|---|---|---|
Optional separator | undefined | 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(): IterableIterator<number>
Inherited from Array.keys
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array
Returns: IterableIterator<number>
lastIndexOf
▸ lastIndexOf(searchElement: Codec, fromIndex?: undefined | number): number
Inherited from Array.lastIndexOf
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1290
Returns the index of the last occurrence of a specified value in an array.
Parameters:
| Name | Type | Description |
|---|---|---|
| searchElement | Codec | The value to locate in the array. |
Optional fromIndex | undefined | number | The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. |
Returns: number
map
▸ map<U>(callbackfn: function, thisArg?: any): Array<U>
Overrides Array.map
Defined in codec/Tuple.ts:149
description: Maps the array with the callback
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | The mapping function |
Optional thisArg | any | The `this` onject to apply the result to |
Returns: Array<U>
pop
▸ pop(): Codec | undefined
Inherited from Array.pop
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1221
Removes the last element from an array and returns it.
Returns: Codec | undefined
push
▸ push(...items: Codec[]): number
Inherited from Array.push
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1226
Appends new elements to an array, and returns the new length of the array.
Parameters:
| Name | Type | Description |
|---|---|---|
Rest items | Codec[] | New elements of the Array. |
Returns: number
reduce
▸ reduce(callbackfn: function): Codec
▸ reduce(callbackfn: function, initialValue: Codec): Codec
▸ reduce<U>(callbackfn: function, initialValue: U): U
Inherited from Array.reduce
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1332
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:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
Returns: Codec
Inherited from Array.reduce
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1333
Parameters:
| Name | Type |
|---|---|
| callbackfn | function |
| initialValue | Codec |
Returns: Codec
Inherited from Array.reduce
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1339
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. |
| initialValue | U | If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. |
Returns: U
reduceRight
▸ reduceRight(callbackfn: function): Codec
▸ reduceRight(callbackfn: function, initialValue: Codec): Codec
▸ reduceRight<U>(callbackfn: function, initialValue: U): U
Inherited from Array.reduceRight
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1345
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:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. |
Returns: Codec
Inherited from Array.reduceRight
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1346
Parameters:
| Name | Type |
|---|---|
| callbackfn | function |
| initialValue | Codec |
Returns: Codec
Inherited from Array.reduceRight
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1352
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
Type parameters:
U
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | 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(): Codec[]
Inherited from Array.reverse
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1245
Reverses the elements in an Array.
Returns: Codec[]
shift
▸ shift(): Codec | undefined
Inherited from Array.shift
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1249
Removes the first element from an array and returns it.
Returns: Codec | undefined
slice
▸ slice(start?: undefined | number, end?: undefined | number): Codec[]
Inherited from Array.slice
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1255
Returns a section of an array.
Parameters:
| Name | Type | Description |
|---|---|---|
Optional start | undefined | number | The beginning of the specified portion of the array. |
Optional end | undefined | number | The end of the specified portion of the array. |
Returns: Codec[]
some
▸ some(callbackfn: function, thisArg?: any): boolean
Inherited from Array.some
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1302
Determines whether the specified callback function returns true for any element of an array.
Parameters:
| Name | Type | Description |
|---|---|---|
| callbackfn | function | A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array. |
Optional 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: boolean
sort
▸ sort(compareFn?: undefined | function): this
Inherited from Array.sort
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1260
Sorts an array.
Parameters:
| Name | Type | Description |
|---|---|---|
Optional compareFn | undefined | function | The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order. |
Returns: this
splice
▸ splice(start: number, deleteCount?: undefined | number): Codec[]
▸ splice(start: number, deleteCount: number, ...items: Codec[]): Codec[]
Inherited from Array.splice
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1266
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters:
| Name | Type | Description |
|---|---|---|
| start | number | The zero-based location in the array from which to start removing elements. |
Optional deleteCount | undefined | number | The number of elements to remove. |
Returns: Codec[]
Inherited from Array.splice
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1273
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
Parameters:
| Name | 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. |
Rest items | Codec[] | Elements to insert into the array in place of the deleted elements. |
Returns: Codec[]
toArray
▸ toArray(): Array<Codec>
Defined in codec/Tuple.ts:91
description: Converts the Object to an standard JavaScript Array
Returns: Array<Codec>
toHex
▸ toHex(): string
Defined in codec/Tuple.ts:98
description: Returns a hex string representation of the value
Returns: string
toJSON
▸ toJSON(): any
Implementation of Codec.toJSON
Defined in codec/Tuple.ts:105
description: Converts the Object to JSON, typically used for RPC transfers
Returns: any
toLocaleString
▸ toLocaleString(): string
Inherited from Array.toLocaleString
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1217
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
Returns: string
toString
▸ toString(): string
Implementation of Codec.toString
Overrides Array.toString
Defined in codec/Tuple.ts:114
description: Returns the string representation of the value
Returns: string
toU8a
▸ toU8a(isBare?: undefined | false | true): Uint8Array
Defined in codec/Tuple.ts:123
description: Encodes the value as a Uint8Array as per the parity-codec specifications
Parameters:
| Name | Type | Description |
|---|---|---|
Optional isBare | undefined | false | true | true when the value has none of the type-specific prefixes (internal) |
Returns: Uint8Array
unshift
▸ unshift(...items: Codec[]): number
Inherited from Array.unshift
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1278
Inserts new elements at the start of an array.
Parameters:
| Name | Type | Description |
|---|---|---|
Rest items | Codec[] | Elements to insert at the start of the Array. |
Returns: number
values
▸ values(): IterableIterator<Codec>
Inherited from Array.values
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array
Returns: IterableIterator<Codec>
<Static> with
▸ with(Types: TupleConstructors): Constructor<Tuple>
Defined in codec/Tuple.ts:48
Parameters:
| Name | Type |
|---|---|
| Types | TupleConstructors |
Returns: Constructor<Tuple>