AlgoAmount
Defined in: algokit-utils-ts/src/types/amount.ts:4
Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AlgoAmount(
amount):AlgoAmount
Defined in: algokit-utils-ts/src/types/amount.ts:37
Create a new AlgoAmount instance.
Parameters
Section titled “Parameters”amount
Section titled “amount”{ algos: number | bigint; } | { algo: number | bigint; } | { microAlgos: number | bigint; } | { microAlgo: number | bigint; }
An object specifying the amount in Algo or µALGO. Use the key ‘algo’ for Algo amounts and ‘microAlgo’ for µALGO.
Returns
Section titled “Returns”AlgoAmount
A new instance of AlgoAmount representing the specified amount.
Example
Section titled “Example”const amount = new AlgoAmount({ algo: 5 });Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get algo():
number
Defined in: algokit-utils-ts/src/types/amount.ts:23
Return the amount as a number in Algo
Returns
Section titled “Returns”number
Get Signature
Section titled “Get Signature”get algos():
number
Defined in: algokit-utils-ts/src/types/amount.ts:18
Return the amount as a number in Algo
Returns
Section titled “Returns”number
microAlgo
Section titled “microAlgo”Get Signature
Section titled “Get Signature”get microAlgo():
bigint
Defined in: algokit-utils-ts/src/types/amount.ts:13
Return the amount as a number in µAlgo
Returns
Section titled “Returns”bigint
microAlgos
Section titled “microAlgos”Get Signature
Section titled “Get Signature”get microAlgos():
bigint
Defined in: algokit-utils-ts/src/types/amount.ts:8
Return the amount as a number in µAlgo
Returns
Section titled “Returns”bigint
Methods
Section titled “Methods”toString()
Section titled “toString()”toString():
string
Defined in: algokit-utils-ts/src/types/amount.ts:50
Returns
Section titled “Returns”string
valueOf()
Section titled “valueOf()”valueOf():
number
Defined in: algokit-utils-ts/src/types/amount.ts:58
valueOf allows you to use AlgoAmount in comparison operations such as < and >= etc.,
but it’s not recommended to use this to convert to a number, it’s much safer to explicitly call
the algos or microAlgos properties
Returns
Section titled “Returns”number
Algo()
Section titled “Algo()”
staticAlgo(amount):AlgoAmount
Defined in: algokit-utils-ts/src/types/amount.ts:68
Create a AlgoAmount object representing the given number of Algo
Parameters
Section titled “Parameters”amount
Section titled “amount”number | bigint
Returns
Section titled “Returns”AlgoAmount
Algos()
Section titled “Algos()”
staticAlgos(amount):AlgoAmount
Defined in: algokit-utils-ts/src/types/amount.ts:63
Create a AlgoAmount object representing the given number of Algo
Parameters
Section titled “Parameters”amount
Section titled “amount”number | bigint
Returns
Section titled “Returns”AlgoAmount
MicroAlgo()
Section titled “MicroAlgo()”
staticMicroAlgo(amount):AlgoAmount
Defined in: algokit-utils-ts/src/types/amount.ts:78
Create a AlgoAmount object representing the given number of µAlgo
Parameters
Section titled “Parameters”amount
Section titled “amount”number | bigint
Returns
Section titled “Returns”AlgoAmount
MicroAlgos()
Section titled “MicroAlgos()”
staticMicroAlgos(amount):AlgoAmount
Defined in: algokit-utils-ts/src/types/amount.ts:73
Create a AlgoAmount object representing the given number of µAlgo
Parameters
Section titled “Parameters”amount
Section titled “amount”number | bigint
Returns
Section titled “Returns”AlgoAmount