Address
@algorandfoundation/algorand-typescript
@algorandfoundation/algorand-typescript / arc4 / Address
Class: Address
Section titled “Class: Address”Defined in: packages/algo-ts/src/arc4/encoded-types.ts:438
A 32 byte Algorand Address
Extends
Section titled “Extends”Indexable
Section titled “Indexable”Constructors
Section titled “Constructors”new Address()
Section titled “new Address()”new Address(
value?):Address
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:446
Create a new Address instance
Parameters
Section titled “Parameters”value?
Section titled “value?”An Account, base 32 address string, or the address bytes
Returns
Section titled “Returns”Overrides
Section titled “Overrides”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get bytes():
bytes
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:97
Retrieve the encoded bytes for this type
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”length
Section titled “length”Get Signature
Section titled “Get Signature”get length():
uint64
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:240
Returns the current length of this array
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”native
Section titled “native”Get Signature
Section titled “Get Signature”get native():
Account
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:453
Returns an Account instance for this Address
Returns
Section titled “Returns”Methods
Section titled “Methods”[iterator]()
Section titled “[iterator]()”[iterator]():
IterableIterator<Byte>
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:277
Returns an iterator for the items in this array
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”at(
index):Byte
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:249
Returns the item at the given index. Negative indexes are taken from the end.
Parameters
Section titled “Parameters”The index of the item to retrieve
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”entries()
Section titled “entries()”entries():
IterableIterator<readonly [uint64,Byte]>
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:284
Returns an iterator for a tuple of the indexes and items in this array
Returns
Section titled “Returns”IterableIterator<readonly [uint64, Byte]>
Inherited from
Section titled “Inherited from”keys()
Section titled “keys()”keys():
IterableIterator<uint64>
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:291
Returns an iterator for the indexes in this array
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”slice()
Section titled “slice()”Call Signature
Section titled “Call Signature”slice():
DynamicArray<Byte>
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:256
Internal
Create a new Dynamic array with all items from this array
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”slice(
end):DynamicArray<Byte>
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:262
Internal
Create a new DynamicArray with all items up till end.
Negative indexes are taken from the end.
Parameters
Section titled “Parameters”An index in which to stop copying items.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”slice(
start,end):DynamicArray<Byte>
Defined in: packages/algo-ts/src/arc4/encoded-types.ts:269
Internal
Create a new DynamicArray with items from start, up until end
Negative indexes are taken from the end.
Parameters
Section titled “Parameters”An index in which to start copying items.
An index in which to stop copying items