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

…rn/all-c6b572903f chore(deps): bump the all group with 10 updates
algorandfoundation · Jan 21, 2024 · b2a91a2 · b2a91a2
2 parents 4d7a198 + ca16027
commit b2a91a2
Show file tree

Hide file tree

Showing 9 changed files with 261 additions and 176 deletions.
diff --git a/docs/code/classes/types_logic_error.LogicError.md b/docs/code/classes/types_logic_error.LogicError.md
@@ -95,7 +95,7 @@ Error.message
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1068
+node_modules/typescript/lib/lib.es5.d.ts:1076
 
 ___
 
@@ -109,7 +109,7 @@ Error.name
 
 #### Defined in
 
-node_modules/typescript/lib/lib.es5.d.ts:1067
+node_modules/typescript/lib/lib.es5.d.ts:1075
 
 ___
 
@@ -151,6 +151,12 @@ ___
 
 ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
 
+Optional override for formatting stack traces
+
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
 #### Type declaration
 
 ▸ (`err`, `stackTraces`): `any`
@@ -231,9 +237,9 @@ Takes an error message and parses out the details of any logic errors in there.
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `error` | `any` |
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `error` | `any` | The error message to parse |
 
 #### Returns
 

diff --git a/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md b/docs/code/interfaces/types_testing.AlgoKitLogCaptureFixture.md
@@ -21,6 +21,8 @@
 
 • **afterEach**: () => `void`
 
+Testing framework agnostic handler method to run after each test to reset the logger.
+
 #### Type declaration
 
 ▸ (): `void`
@@ -41,6 +43,8 @@ ___
 
 • **beforeEach**: () => `void`
 
+Testing framework agnostic handler method to run before each test to prepare the `testLogger` for that test.
+
 #### Type declaration
 
 ▸ (): `void`

diff --git a/docs/code/interfaces/types_testing.AlgorandFixture.md b/docs/code/interfaces/types_testing.AlgorandFixture.md
@@ -22,6 +22,8 @@ An Algorand automated testing fixture
 
 • **beforeEach**: () => `Promise`\<`void`\>
 
+Testing framework agnostic handler method to run before each test to prepare the `context` for that test.
+
 #### Type declaration
 
 ▸ (): `Promise`\<`void`\>

diff --git a/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md b/docs/code/interfaces/types_testing.AlgorandTestAutomationContext.md
@@ -37,6 +37,8 @@ ___
 
 • **generateAccount**: (`params`: [`GetTestAccountParams`](types_testing.GetTestAccountParams.md)) => `Promise`\<`default`\>
 
+Generate and fund an additional ephemerally created account
+
 #### Type declaration
 
 ▸ (`params`): `Promise`\<`default`\>
@@ -111,6 +113,8 @@ ___
 
 • **waitForIndexer**: () => `Promise`\<`void`\>
 
+Wait for the indexer to catch up with all transactions logged by `transactionLogger`
+
 #### Type declaration
 
 ▸ (): `Promise`\<`void`\>
@@ -131,6 +135,8 @@ ___
 
 • **waitForIndexerTransaction**: (`transactionId`: `string`) => `Promise`\<[`TransactionLookupResult`](types_indexer.TransactionLookupResult.md)\>
 
+Wait for the indexer to catch up with the given transaction ID
+
 #### Type declaration
 
 ▸ (`transactionId`): `Promise`\<[`TransactionLookupResult`](types_indexer.TransactionLookupResult.md)\>

diff --git a/docs/code/modules/index.md b/docs/code/modules/index.md
@@ -1749,7 +1749,7 @@ A transaction signer
 
 #### Defined in
 
-[src/transaction.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L110)
+[src/transaction.ts:152](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/transaction.ts#L152)
 
 ___
 
@@ -1939,7 +1939,7 @@ Looks up an account by address using Indexer.
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `accountAddress` | `string` | - |
+| `accountAddress` | `string` | The address of the account to look up |
 | `indexer` | `default` | An indexer client |
 
 #### Returns