name: Tuple
description: A Tuple defines an anonymous fixed-length array, where each element has its own type. It extends the base JS Array object.
Hierarchy
Array<Codec>
↳ Tuple
↳ Seal
Implements
Indexable
[n: number]: Codec
Constructors
constructor
⊕ new Tuple(Types: TupleConstructors, value: any): Tuple
Defined in codec/Tuple.ts:22
Parameters:
| Name | Type |
|---|---|
| Types | TupleConstructors |
| value | any |
Returns: Tuple
Properties
<Static> Array
● Array: ArrayConstructor
Defined in /home/travis/build/polkadot-js/api/node_modules/typescript/lib/lib.es5.d.ts:1368
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
Defined in codec/Tuple.ts:59
description: The length of the value when encoded as a Uint8Array
Returns: number
isEmpty
get isEmpty(): boolean
Defined in codec/Tuple.ts:68
description: Checks if the value is an empty value
Returns: boolean
Methods
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
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>
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>
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
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
<Static> with
▸ with(Types: TupleConstructors): Constructor<Tuple>
Defined in codec/Tuple.ts:48
Parameters:
| Name | Type |
|---|---|
| Types | TupleConstructors |
Returns: Constructor<Tuple>