1- [ @algorandfoundation/algokit-utils ] ( ../README.md ) / [ types/amount ] ( ../modules/types_amount .md ) / AlgoAmount
1+ [ @algorandfoundation/algokit-utils ] ( ../README.md ) / [ index ] ( ../modules/index .md ) / AlgoAmount
22
33# Class: AlgoAmount
44
5- [ types/amount ] ( ../modules/types_amount .md ) .AlgoAmount
5+ [ index ] ( ../modules/index .md ) .AlgoAmount
66
77Wrapper class to ensure safe, explicit conversion between µAlgo, Algo and numbers
88
99## Table of contents
1010
1111### Constructors
1212
13- - [ constructor] ( types_amount .AlgoAmount.md#constructor)
13+ - [ constructor] ( index .AlgoAmount.md#constructor)
1414
1515### Properties
1616
17- - [ amountInMicroAlgo] ( types_amount .AlgoAmount.md#amountinmicroalgo)
17+ - [ amountInMicroAlgo] ( index .AlgoAmount.md#amountinmicroalgo)
1818
1919### Accessors
2020
21- - [ algo] ( types_amount .AlgoAmount.md#algo)
22- - [ algos] ( types_amount .AlgoAmount.md#algos)
23- - [ microAlgo] ( types_amount .AlgoAmount.md#microalgo)
24- - [ microAlgos] ( types_amount .AlgoAmount.md#microalgos)
21+ - [ algo] ( index .AlgoAmount.md#algo)
22+ - [ algos] ( index .AlgoAmount.md#algos)
23+ - [ microAlgo] ( index .AlgoAmount.md#microalgo)
24+ - [ microAlgos] ( index .AlgoAmount.md#microalgos)
2525
2626### Methods
2727
28- - [ toString] ( types_amount .AlgoAmount.md#tostring)
29- - [ valueOf] ( types_amount .AlgoAmount.md#valueof)
30- - [ Algo] ( types_amount .AlgoAmount.md#algo-1)
31- - [ Algos] ( types_amount .AlgoAmount.md#algos-1)
32- - [ MicroAlgo] ( types_amount .AlgoAmount.md#microalgo-1)
33- - [ MicroAlgos] ( types_amount .AlgoAmount.md#microalgos-1)
28+ - [ toString] ( index .AlgoAmount.md#tostring)
29+ - [ valueOf] ( index .AlgoAmount.md#valueof)
30+ - [ Algo] ( index .AlgoAmount.md#algo-1)
31+ - [ Algos] ( index .AlgoAmount.md#algos-1)
32+ - [ MicroAlgo] ( index .AlgoAmount.md#microalgo-1)
33+ - [ MicroAlgos] ( index .AlgoAmount.md#microalgos-1)
3434
3535## Constructors
3636
3737### constructor
3838
39- • ** new AlgoAmount** (` amount ` ): [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
39+ • ** new AlgoAmount** (` amount ` ): [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
4040
4141Create a new ` AlgoAmount ` instance.
4242
@@ -48,7 +48,7 @@ Create a new `AlgoAmount` instance.
4848
4949#### Returns
5050
51- [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
51+ [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
5252
5353A new instance of ` AlgoAmount ` representing the specified amount.
5454
@@ -60,7 +60,7 @@ const amount = new AlgoAmount({ algo: 5 });
6060
6161#### Defined in
6262
63- [ src/types/ amount.ts:35] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L35 )
63+ [ src/amount.ts:35] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L35 )
6464
6565## Properties
6666
@@ -70,7 +70,7 @@ const amount = new AlgoAmount({ algo: 5 });
7070
7171#### Defined in
7272
73- [ src/types/ amount.ts:3] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L3 )
73+ [ src/amount.ts:3] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L3 )
7474
7575## Accessors
7676
@@ -86,7 +86,7 @@ Return the amount as a number in Algo
8686
8787#### Defined in
8888
89- [ src/types/ amount.ts:21] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L21 )
89+ [ src/amount.ts:21] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L21 )
9090
9191___
9292
@@ -102,7 +102,7 @@ Return the amount as a number in Algo
102102
103103#### Defined in
104104
105- [ src/types/ amount.ts:16] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L16 )
105+ [ src/amount.ts:16] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L16 )
106106
107107___
108108
@@ -118,7 +118,7 @@ Return the amount as a number in µAlgo
118118
119119#### Defined in
120120
121- [ src/types/ amount.ts:11] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L11 )
121+ [ src/amount.ts:11] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L11 )
122122
123123___
124124
@@ -134,7 +134,7 @@ Return the amount as a number in µAlgo
134134
135135#### Defined in
136136
137- [ src/types/ amount.ts:6] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L6 )
137+ [ src/amount.ts:6] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L6 )
138138
139139## Methods
140140
@@ -148,7 +148,7 @@ Return the amount as a number in µAlgo
148148
149149#### Defined in
150150
151- [ src/types/ amount.ts:48] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L48 )
151+ [ src/amount.ts:48] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L48 )
152152
153153___
154154
@@ -166,13 +166,13 @@ the algos or microAlgos properties
166166
167167#### Defined in
168168
169- [ src/types/ amount.ts:56] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L56 )
169+ [ src/amount.ts:56] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L56 )
170170
171171___
172172
173173### Algo
174174
175- ▸ ** Algo** (` amount ` ): [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
175+ ▸ ** Algo** (` amount ` ): [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
176176
177177Create a ` AlgoAmount ` object representing the given number of Algo
178178
@@ -184,17 +184,17 @@ Create a `AlgoAmount` object representing the given number of Algo
184184
185185#### Returns
186186
187- [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
187+ [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
188188
189189#### Defined in
190190
191- [ src/types/ amount.ts:66] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L66 )
191+ [ src/amount.ts:66] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L66 )
192192
193193___
194194
195195### Algos
196196
197- ▸ ** Algos** (` amount ` ): [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
197+ ▸ ** Algos** (` amount ` ): [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
198198
199199Create a ` AlgoAmount ` object representing the given number of Algo
200200
@@ -206,17 +206,17 @@ Create a `AlgoAmount` object representing the given number of Algo
206206
207207#### Returns
208208
209- [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
209+ [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
210210
211211#### Defined in
212212
213- [ src/types/ amount.ts:61] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L61 )
213+ [ src/amount.ts:61] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L61 )
214214
215215___
216216
217217### MicroAlgo
218218
219- ▸ ** MicroAlgo** (` amount ` ): [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
219+ ▸ ** MicroAlgo** (` amount ` ): [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
220220
221221Create a ` AlgoAmount ` object representing the given number of µAlgo
222222
@@ -228,17 +228,17 @@ Create a `AlgoAmount` object representing the given number of µAlgo
228228
229229#### Returns
230230
231- [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
231+ [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
232232
233233#### Defined in
234234
235- [ src/types/ amount.ts:76] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L76 )
235+ [ src/amount.ts:76] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L76 )
236236
237237___
238238
239239### MicroAlgos
240240
241- ▸ ** MicroAlgos** (` amount ` ): [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
241+ ▸ ** MicroAlgos** (` amount ` ): [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
242242
243243Create a ` AlgoAmount ` object representing the given number of µAlgo
244244
@@ -250,8 +250,8 @@ Create a `AlgoAmount` object representing the given number of µAlgo
250250
251251#### Returns
252252
253- [ ` AlgoAmount ` ] ( types_amount .AlgoAmount.md)
253+ [ ` AlgoAmount ` ] ( index .AlgoAmount.md)
254254
255255#### Defined in
256256
257- [ src/types/ amount.ts:71] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types /amount.ts#L71 )
257+ [ src/amount.ts:71] ( https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/amount.ts#L71 )
0 commit comments