AlgoAmount
@algorandfoundation/algokit-utils / types/amount / AlgoAmount
types/amount.AlgoAmount
Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers
Table of contents
Section titled “Table of contents”Constructors
Section titled “Constructors”Properties
Section titled “Properties”Accessors
Section titled “Accessors”Methods
Section titled “Methods”Constructors
Section titled “Constructors”constructor
Section titled “constructor”• new AlgoAmount(amount): AlgoAmount
Create a new AlgoAmount instance.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
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”A new instance of AlgoAmount representing the specified amount.
Example
const amount = new AlgoAmount({ algo: 5 });Defined in
Section titled “Defined in”Properties
Section titled “Properties”amountInMicroAlgo
Section titled “amountInMicroAlgo”• Private amountInMicroAlgo: bigint
Defined in
Section titled “Defined in”Accessors
Section titled “Accessors”• get algo(): number
Return the amount as a number in Algo
Returns
Section titled “Returns”number
Defined in
Section titled “Defined in”• get algos(): number
Return the amount as a number in Algo
Returns
Section titled “Returns”number
Defined in
Section titled “Defined in”microAlgo
Section titled “microAlgo”• get microAlgo(): bigint
Return the amount as a number in µAlgo
Returns
Section titled “Returns”bigint
Defined in
Section titled “Defined in”microAlgos
Section titled “microAlgos”• get microAlgos(): bigint
Return the amount as a number in µAlgo
Returns
Section titled “Returns”bigint
Defined in
Section titled “Defined in”Methods
Section titled “Methods”toString
Section titled “toString”▸ toString(): string
Returns
Section titled “Returns”string
Defined in
Section titled “Defined in”valueOf
Section titled “valueOf”▸ valueOf(): number
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
Defined in
Section titled “Defined in”▸ Algo(amount): AlgoAmount
Create a AlgoAmount object representing the given number of Algo
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
amount | number | bigint |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”▸ Algos(amount): AlgoAmount
Create a AlgoAmount object representing the given number of Algo
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
amount | number | bigint |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”MicroAlgo
Section titled “MicroAlgo”▸ MicroAlgo(amount): AlgoAmount
Create a AlgoAmount object representing the given number of µAlgo
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
amount | number | bigint |
Returns
Section titled “Returns”Defined in
Section titled “Defined in”MicroAlgos
Section titled “MicroAlgos”▸ MicroAlgos(amount): AlgoAmount
Create a AlgoAmount object representing the given number of µAlgo
Parameters
Section titled “Parameters”| Name | Type |
|---|---|
amount | number | bigint |