Class Tuple<TTuple>

An arc4 encoded tuple of values

Type Parameters

const TTuple extends readonly [ARC4Encoded, ...ARC4Encoded[]]
A type representing the native tuple of item types

Hierarchy

ARC4Encoded
- Tuple

Index

Constructors

Accessors

bytes length native

Methods

Constructors

constructor

new Tuple<const TTuple extends readonly [ARC4Encoded, ARC4Encoded]>(): Tuple<
TTuple,
>
Create a new Tuple with the default zero values for items
Type Parameters
- const TTuple extends readonly [ARC4Encoded, ARC4Encoded]
Returns Tuple<TTuple>
Overrides ARC4Encoded.constructor
- Defined in arc4/encoded-types.ts:415
new Tuple<const TTuple extends readonly [ARC4Encoded, ARC4Encoded]>(
...items: TTuple,
): Tuple<TTuple>
Create a new Tuple with the specified items
Type Parameters
- const TTuple extends readonly [ARC4Encoded, ARC4Encoded]
Parameters
- ...items: TTuple
  The tuple items
Returns Tuple<TTuple>
Overrides ARC4Encoded.constructor
- Defined in arc4/encoded-types.ts:420

Accessors

bytes

get bytes(): bytes
Retrieve the encoded bytes for this type

Returns bytes
Inherited from ARC4Encoded.bytes
- Defined in arc4/encoded-types.ts:102

length

get length(): TTuple["length"] & {} & number
Returns the length of this tuple

Returns TTuple["length"] & {} & number
- Defined in arc4/encoded-types.ts:436

native

get native(): TTuple
Returns the decoded native tuple (with arc4 encoded items)

Returns TTuple
- Defined in arc4/encoded-types.ts:443

Methods

at

at<TIndex extends string | number | symbol>(index: TIndex): TTuple[TIndex]
Returns the item at the specified index
Type Parameters
- TIndex extends string | number | symbol
Parameters
- index: TIndex
  The index of the item to get. Must be a positive literal representing a tuple index
Returns TTuple[TIndex]
- Defined in arc4/encoded-types.ts:429