Tuple

@algorandfoundation/algorand-typescript

---

@algorandfoundation/algorand-typescript / arc4 / Tuple

Class: Tuple<TTuple>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:400

An arc4 encoded tuple of values

Extends

• ARC4Encoded

Type Parameters

• TTuple extends [ARC4Encoded, ...ARC4Encoded[]]

A type representing the native tuple of item types

Constructors

new Tuple()

new Tuple<TTuple>(…items): Tuple<TTuple>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:408

Create a new Tuple with the specified items

Parameters

items

…TTuple

The tuple items

Returns

Tuple<TTuple>

Overrides

ARC4Encoded.constructor

Accessors

bytes

Get Signature

get bytes(): bytes

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:97

Retrieve the encoded bytes for this type

Returns

bytes

Inherited from

ARC4Encoded.bytes

---

length

Get Signature

get length(): TTuple["length"] & object & number

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:423

Returns the length of this tuple

Returns

TTuple["length"] & object & number

---

native

Get Signature

get native(): TTuple

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:430

Returns the decoded native tuple (with arc4 encoded items)

Returns

TTuple

Methods

at()

at<TIndex>(index): TTuple[TIndex]

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:416

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]