Skip to content

Commit fe9cfe8

Browse files
authored
Merge pull request #527 from algorandfoundation/feat/deprecate-types
Move features under src/types to src/
2 parents e977e95 + c43afb8 commit fe9cfe8

File tree

255 files changed

+16994
-30645
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

255 files changed

+16994
-30645
lines changed

docs/code/README.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,23 @@
1010
- [testing](modules/testing.md)
1111
- [types/account](modules/types_account.md)
1212
- [types/account-manager](modules/types_account_manager.md)
13-
- [types/account-manager.spec](modules/types_account_manager_spec.md)
1413
- [types/algorand-client](modules/types_algorand_client.md)
1514
- [types/algorand-client-transaction-creator](modules/types_algorand_client_transaction_creator.md)
1615
- [types/algorand-client-transaction-sender](modules/types_algorand_client_transaction_sender.md)
17-
- [types/algorand-client.asset.spec](modules/types_algorand_client_asset_spec.md)
18-
- [types/algorand-client.spec](modules/types_algorand_client_spec.md)
19-
- [types/algorand-client.transfer.spec](modules/types_algorand_client_transfer_spec.md)
2016
- [types/amount](modules/types_amount.md)
21-
- [types/amount.spec](modules/types_amount_spec.md)
2217
- [types/app](modules/types_app.md)
2318
- [types/app-client](modules/types_app_client.md)
24-
- [types/app-client.spec](modules/types_app_client_spec.md)
2519
- [types/app-deployer](modules/types_app_deployer.md)
2620
- [types/app-factory](modules/types_app_factory.md)
27-
- [types/app-factory-and-client.spec](modules/types_app_factory_and_client_spec.md)
2821
- [types/app-manager](modules/types_app_manager.md)
2922
- [types/app-spec](modules/types_app_spec.md)
3023
- [types/asset-manager](modules/types_asset_manager.md)
3124
- [types/async-event-emitter](modules/types_async_event_emitter.md)
32-
- [types/async-event-emitter.spec](modules/types_async_event_emitter_spec.md)
3325
- [types/client-manager](modules/types_client_manager.md)
34-
- [types/client-manager.spec](modules/types_client_manager_spec.md)
3526
- [types/composer](modules/types_composer.md)
36-
- [types/composer.spec](modules/types_composer_spec.md)
3727
- [types/config](modules/types_config.md)
3828
- [types/debugging](modules/types_debugging.md)
3929
- [types/dispenser-client](modules/types_dispenser_client.md)
40-
- [types/dispenser-client.spec](modules/types_dispenser_client_spec.md)
4130
- [types/expand](modules/types_expand.md)
4231
- [types/indexer](modules/types_indexer.md)
4332
- [types/instance-of](modules/types_instance_of.md)

docs/code/classes/types_amount.AlgoAmount.md renamed to docs/code/classes/index.AlgoAmount.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
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

77
Wrapper 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

4141
Create 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

5353
A 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

177177
Create 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

199199
Create 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

221221
Create 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

243243
Create 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

Comments
 (0)