Merge pull request #153 from algorandfoundation/dependabot/npm_and_ya…

…rn/typedoc-0.25.3 build(deps-dev): bump typedoc from 0.25.0 to 0.25.3
algorandfoundation · Nov 16, 2023 · 6402ebd · 6402ebd
2 parents fefc859 + 4c4c61d
commit 6402ebd
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 25 deletions.
diff --git a/docs/code/classes/testing.TestLogger.md b/docs/code/classes/testing.TestLogger.md
@@ -40,7 +40,7 @@ This is useful for automated testing.
 
 ### constructor
 
-• **new TestLogger**(`originalLogger?`)
+• **new TestLogger**(`originalLogger?`): [`TestLogger`](testing.TestLogger.md)
 
 Create a new test logger that wraps the given logger if provided.
 
@@ -50,6 +50,10 @@ Create a new test logger that wraps the given logger if provided.
 | :------ | :------ | :------ |
 | `originalLogger?` | [`Logger`](../modules/types_logging.md#logger) | The optional original logger to wrap. |
 
+#### Returns
+
+[`TestLogger`](testing.TestLogger.md)
+
 #### Defined in
 
 [src/testing/test-logger.ts:16](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/testing/test-logger.ts#L16)

diff --git a/docs/code/classes/testing.TransactionLogger.md b/docs/code/classes/testing.TransactionLogger.md
@@ -32,7 +32,11 @@ Useful for automated tests.
 
 ### constructor
 
-• **new TransactionLogger**()
+• **new TransactionLogger**(): [`TransactionLogger`](testing.TransactionLogger.md)
+
+#### Returns
+
+[`TransactionLogger`](testing.TransactionLogger.md)
 
 ## Properties
 

diff --git a/docs/code/classes/types_account.MultisigAccount.md b/docs/code/classes/types_account.MultisigAccount.md
@@ -34,7 +34,7 @@ Account wrapper that supports partial or full multisig signing.
 
 ### constructor
 
-• **new MultisigAccount**(`multisigParams`, `signingAccounts`)
+• **new MultisigAccount**(`multisigParams`, `signingAccounts`): [`MultisigAccount`](types_account.MultisigAccount.md)
 
 #### Parameters
 
@@ -43,6 +43,10 @@ Account wrapper that supports partial or full multisig signing.
 | `multisigParams` | `MultisigMetadata` |
 | `signingAccounts` | (`default` \| [`SigningAccount`](types_account.SigningAccount.md))[] |
 
+#### Returns
+
+[`MultisigAccount`](types_account.MultisigAccount.md)
+
 #### Defined in
 
 [src/types/account.ts:38](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L38)

diff --git a/docs/code/classes/types_account.SigningAccount.md b/docs/code/classes/types_account.SigningAccount.md
@@ -33,7 +33,7 @@ Account wrapper that supports a rekeyed account
 
 ### constructor
 
-• **new SigningAccount**(`account`, `sender`)
+• **new SigningAccount**(`account`, `sender`): [`SigningAccount`](types_account.SigningAccount.md)
 
 #### Parameters
 
@@ -42,6 +42,10 @@ Account wrapper that supports a rekeyed account
 | `account` | `default` |
 | `sender` | `undefined` \| `string` |
 
+#### Returns
+
+[`SigningAccount`](types_account.SigningAccount.md)
+
 #### Defined in
 
 [src/types/account.ts:104](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L104)

diff --git a/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md b/docs/code/classes/types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md
@@ -36,7 +36,7 @@ A HTTP Client that wraps the Algorand SDK HTTP Client with retries
 
 ### constructor
 
-• **new AlgoHttpClientWithRetry**(`tokenHeader`, `baseServer`, `port?`, `defaultHeaders?`)
+• **new AlgoHttpClientWithRetry**(`tokenHeader`, `baseServer`, `port?`, `defaultHeaders?`): [`AlgoHttpClientWithRetry`](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md)
 
 #### Parameters
 
@@ -47,6 +47,10 @@ A HTTP Client that wraps the Algorand SDK HTTP Client with retries
 | `port?` | `string` \| `number` |
 | `defaultHeaders` | `Record`<`string`, `any`\> |
 
+#### Returns
+
+[`AlgoHttpClientWithRetry`](types_algo_http_client_with_retry.AlgoHttpClientWithRetry.md)
+
 #### Inherited from
 
 [URLTokenBaseHTTPClient](types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md).[constructor](types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md#constructor)
@@ -99,7 +103,7 @@ ___
 
 ### callWithRetry
 
-▸ `Private` **callWithRetry**(`func`): `Promise`<`BaseHTTPClientResponse`\>
+▸ **callWithRetry**(`func`): `Promise`<`BaseHTTPClientResponse`\>
 
 #### Parameters
 

diff --git a/docs/code/classes/types_amount.AlgoAmount.md b/docs/code/classes/types_amount.AlgoAmount.md
@@ -32,14 +32,18 @@ Wrapper class to ensure safe, explicit conversion between µAlgos, Algos and num
 
 ### constructor
 
-• **new AlgoAmount**(`amount`)
+• **new AlgoAmount**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `amount` | { `algos`: `number`  } \| { `microAlgos`: `number`  } |
 
+#### Returns
+
+[`AlgoAmount`](types_amount.AlgoAmount.md)
+
 #### Defined in
 
 [src/types/amount.ts:17](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/amount.ts#L17)
@@ -122,7 +126,7 @@ ___
 
 ### Algos
 
-▸ `Static` **Algos**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md)
+▸ **Algos**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md)
 
 Create a `AlgoAmount` object representing the given number of Algos
 
@@ -144,7 +148,7 @@ ___
 
 ### MicroAlgos
 
-▸ `Static` **MicroAlgos**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md)
+▸ **MicroAlgos**(`amount`): [`AlgoAmount`](types_amount.AlgoAmount.md)
 
 Create a `AlgoAmount` object representing the given number of µAlgos
 

diff --git a/docs/code/classes/types_app_client.ApplicationClient.md b/docs/code/classes/types_app_client.ApplicationClient.md
@@ -60,7 +60,7 @@ Application client - a class that wraps an ARC-0032 app spec and provides high p
 
 ### constructor
 
-• **new ApplicationClient**(`appDetails`, `algod`)
+• **new ApplicationClient**(`appDetails`, `algod`): [`ApplicationClient`](types_app_client.ApplicationClient.md)
 
 Create a new ApplicationClient instance
 
@@ -71,6 +71,10 @@ Create a new ApplicationClient instance
 | `appDetails` | [`AppSpecAppDetails`](../modules/types_app_client.md#appspecappdetails) | The details of the app |
 | `algod` | `default` | An algod instance |
 
+#### Returns
+
+[`ApplicationClient`](types_app_client.ApplicationClient.md)
+
 #### Defined in
 
 [src/types/app-client.ts:288](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L288)

diff --git a/docs/code/classes/types_config.UpdatableConfig.md b/docs/code/classes/types_config.UpdatableConfig.md
@@ -35,7 +35,11 @@ Updatable AlgoKit config
 
 ### constructor
 
-• **new UpdatableConfig**()
+• **new UpdatableConfig**(): [`UpdatableConfig`](types_config.UpdatableConfig.md)
+
+#### Returns
+
+[`UpdatableConfig`](types_config.UpdatableConfig.md)
 
 #### Defined in
 

diff --git a/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md b/docs/code/classes/types_dispenser_client.TestNetDispenserApiClient.md
@@ -64,14 +64,18 @@ If neither the environment variable 'ALGOKIT_DISPENSER_ACCESS_TOKEN' nor the aut
 
 ### constructor
 
-• **new TestNetDispenserApiClient**(`params`)
+• **new TestNetDispenserApiClient**(`params`): [`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `params` | ``null`` \| [`TestNetDispenserApiClientParams`](../interfaces/types_dispenser_client.TestNetDispenserApiClientParams.md) |
 
+#### Returns
+
+[`TestNetDispenserApiClient`](types_dispenser_client.TestNetDispenserApiClient.md)
+
 #### Defined in
 
 [src/types/dispenser-client.ts:61](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/dispenser-client.ts#L61)
@@ -175,7 +179,7 @@ ___
 
 ### processDispenserRequest
 
-▸ `Private` **processDispenserRequest**(`authToken`, `urlSuffix`, `body?`, `method?`): `Promise`<`Response`\>
+▸ **processDispenserRequest**(`authToken`, `urlSuffix`, `body?`, `method?`): `Promise`<`Response`\>
 
 Processes a dispenser API request.
 

diff --git a/docs/code/classes/types_logic_error.LogicError.md b/docs/code/classes/types_logic_error.LogicError.md
@@ -39,7 +39,7 @@ Wraps key functionality around processing logic errors
 
 ### constructor
 
-• **new LogicError**(`errorDetails`, `program`, `map`)
+• **new LogicError**(`errorDetails`, `program`, `map`): [`LogicError`](types_logic_error.LogicError.md)
 
 Create a new logic error object.
 
@@ -51,6 +51,10 @@ Create a new logic error object.
 | `program` | `string`[] | The TEAL source code, split by line |
 | `map` | `SourceMap` | The source map of the TEAL source code |
 
+#### Returns
+
+[`LogicError`](types_logic_error.LogicError.md)
+
 #### Overrides
 
 Error.constructor
@@ -194,7 +198,7 @@ node_modules/@types/node/globals.d.ts:13
 
 ### captureStackTrace
 
-▸ `Static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
 
 Create .stack property on a target object
 
@@ -221,7 +225,7 @@ ___
 
 ### parseLogicError
 
-▸ `Static` **parseLogicError**(`error`): `undefined` \| [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md)
+▸ **parseLogicError**(`error`): `undefined` \| [`LogicErrorDetails`](../interfaces/types_logic_error.LogicErrorDetails.md)
 
 Takes an error message and parses out the details of any logic errors in there.
 

diff --git a/docs/code/classes/types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md b/docs/code/classes/types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md
@@ -44,7 +44,7 @@ This is the default implementation of BaseHTTPClient.
 
 ### constructor
 
-• **new URLTokenBaseHTTPClient**(`tokenHeader`, `baseServer`, `port?`, `defaultHeaders?`)
+• **new URLTokenBaseHTTPClient**(`tokenHeader`, `baseServer`, `port?`, `defaultHeaders?`): [`URLTokenBaseHTTPClient`](types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md)
 
 #### Parameters
 
@@ -55,6 +55,10 @@ This is the default implementation of BaseHTTPClient.
 | `port?` | `string` \| `number` |
 | `defaultHeaders` | `Record`<`string`, `any`\> |
 
+#### Returns
+
+[`URLTokenBaseHTTPClient`](types_urlTokenBaseHTTPClient.URLTokenBaseHTTPClient.md)
+
 #### Defined in
 
 [src/types/urlTokenBaseHTTPClient.ts:47](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/urlTokenBaseHTTPClient.ts#L47)
@@ -146,7 +150,7 @@ ___
 
 ### getURL
 
-▸ `Private` **getURL**(`relativePath`, `query?`): `string`
+▸ **getURL**(`relativePath`, `query?`): `string`
 
 Compute the URL for a path relative to the instance's address
 
@@ -198,7 +202,7 @@ ___
 
 ### checkHttpError
 
-▸ `Static` `Private` **checkHttpError**(`res`): `Promise`<`void`\>
+▸ **checkHttpError**(`res`): `Promise`<`void`\>
 
 #### Parameters
 
@@ -218,7 +222,7 @@ ___
 
 ### formatFetchResponse
 
-▸ `Static` `Private` **formatFetchResponse**(`res`): `Promise`<`BaseHTTPClientResponse`\>
+▸ **formatFetchResponse**(`res`): `Promise`<`BaseHTTPClientResponse`\>
 
 #### Parameters
 
@@ -238,7 +242,7 @@ ___
 
 ### formatFetchResponseHeaders
 
-▸ `Static` `Private` **formatFetchResponseHeaders**(`headers`): `Record`<`string`, `string`\>
+▸ **formatFetchResponseHeaders**(`headers`): `Record`<`string`, `string`\>
 
 #### Parameters
 

diff --git a/package-lock.json b/package-lock.json