Update docs

ovotech · Nov 12, 2023 · dec7849 · dec7849
1 parent 1a8b105
commit dec7849
Show file tree

Hide file tree

Showing 12 changed files with 62 additions and 62 deletions.
diff --git a/docs/api/README.md b/docs/api/README.md
@@ -36,7 +36,7 @@ Genesys Web Messaging Tester
 
 ### Response
 
-Ƭ **Response**<`T`\>: `SuccessResponse`<`T`\> \| `FailureResponse`
+Ƭ **Response**\<`T`\>: `SuccessResponse`\<`T`\> \| `FailureResponse`
 
 #### Type parameters
 

diff --git a/docs/api/classes/BotDisconnectedWaitingForResponseError.md b/docs/api/classes/BotDisconnectedWaitingForResponseError.md
@@ -106,10 +106,6 @@ ___
 
 Optional override for formatting stack traces
 
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
 ##### Parameters
 
 | Name | Type |
@@ -121,6 +117,10 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 `any`
 
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
 #### Inherited from
 
 Error.prepareStackTrace

diff --git a/docs/api/classes/Conversation.md b/docs/api/classes/Conversation.md
@@ -61,7 +61,7 @@ console.log(reply);
 
 ### sendText
 
-▸ **sendText**(`text`, `delayInMs?`): `Promise`<`void`\>
+▸ **sendText**(`text`, `delayInMs?`): `Promise`\<`void`\>
 
 Sends text to the conversation
 
@@ -74,7 +74,7 @@ Sends text to the conversation
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Defined in
 
@@ -84,7 +84,7 @@ ___
 
 ### waitForConversationToStart
 
-▸ **waitForConversationToStart**(): `Promise`<[`Conversation`](Conversation.md)\>
+▸ **waitForConversationToStart**(): `Promise`\<[`Conversation`](Conversation.md)\>
 
 Resolves when the conversation has started.
 
@@ -93,7 +93,7 @@ background. This method allows you to wait for this process to finish.
 
 #### Returns
 
-`Promise`<[`Conversation`](Conversation.md)\>
+`Promise`\<[`Conversation`](Conversation.md)\>
 
 #### Defined in
 
@@ -103,15 +103,15 @@ ___
 
 ### waitForResponseText
 
-▸ **waitForResponseText**(): `Promise`<`string`\>
+▸ **waitForResponseText**(): `Promise`\<`string`\>
 
 Resolves on the next response from the other participant in the conversation that contains text.
 
 If you want to wait for a specific message use [waitForResponseWithTextContaining](Conversation.md#waitforresponsewithtextcontaining).
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 
@@ -121,7 +121,7 @@ ___
 
 ### waitForResponseWithTextContaining
 
-▸ **waitForResponseWithTextContaining**(`text`, `«destructured»?`): `Promise`<`string`\>
+▸ **waitForResponseWithTextContaining**(`text`, `«destructured»?`): `Promise`\<`string`\>
 
 Resolves when a response is received that contains a specific piece of text.
 If no response is received that contains the text within the timeout period
@@ -143,7 +143,7 @@ use [waitForResponseText](Conversation.md#waitforresponsetext).
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 
@@ -153,7 +153,7 @@ ___
 
 ### waitForResponseWithTextMatchingPattern
 
-▸ **waitForResponseWithTextMatchingPattern**(`pattern`, `«destructured»?`): `Promise`<`string`\>
+▸ **waitForResponseWithTextMatchingPattern**(`pattern`, `«destructured»?`): `Promise`\<`string`\>
 
 Resolves when a response is received that matches a regular expression.
 If no response is received that matches the pattern within the timeout period
@@ -172,7 +172,7 @@ use [waitForResponseText](Conversation.md#waitforresponsetext).
 
 #### Returns
 
-`Promise`<`string`\>
+`Promise`\<`string`\>
 
 #### Defined in
 
@@ -182,7 +182,7 @@ ___
 
 ### waitForResponses
 
-▸ **waitForResponses**(`timeToWaitAfterLastMessageInMs?`): `Promise`<`string`[]\>
+▸ **waitForResponses**(`timeToWaitAfterLastMessageInMs?`): `Promise`\<`string`[]\>
 
 Wait for all responses until there is a predefined amount of 'silence'.
 
@@ -194,7 +194,7 @@ Wait for all responses until there is a predefined amount of 'silence'.
 
 #### Returns
 
-`Promise`<`string`[]\>
+`Promise`\<`string`[]\>
 
 #### Defined in
 

diff --git a/docs/api/classes/ReorderedMessageDelayer.md b/docs/api/classes/ReorderedMessageDelayer.md
@@ -193,7 +193,7 @@ before releasing the oldest message.
 
 | Name | Type |
 | :------ | :------ |
-| `message` | [`Response`](../README.md#response)<`unknown`\> |
+| `message` | [`Response`](../README.md#response)\<`unknown`\> |
 | `received` | `Date` |
 
 #### Returns
@@ -630,10 +630,6 @@ ___
 
 ▸ `Static` **listenerCount**(`emitter`, `event`): `number`
 
-**`Deprecated`**
-
-since v4.0.0
-
 #### Parameters
 
 | Name | Type |
@@ -645,6 +641,10 @@ since v4.0.0
 
 `number`
 
+**`Deprecated`**
+
+since v4.0.0
+
 #### Inherited from
 
 EventEmitter.listenerCount
@@ -657,7 +657,7 @@ ___
 
 ### on
 
-▸ `Static` **on**(`emitter`, `event`): `AsyncIterableIterator`<`any`\>
+▸ `Static` **on**(`emitter`, `event`): `AsyncIterableIterator`\<`any`\>
 
 #### Parameters
 
@@ -668,7 +668,7 @@ ___
 
 #### Returns
 
-`AsyncIterableIterator`<`any`\>
+`AsyncIterableIterator`\<`any`\>
 
 #### Inherited from
 
@@ -682,7 +682,7 @@ ___
 
 ### once
 
-▸ `Static` **once**(`emitter`, `event`): `Promise`<`any`[]\>
+▸ `Static` **once**(`emitter`, `event`): `Promise`\<`any`[]\>
 
 #### Parameters
 
@@ -693,7 +693,7 @@ ___
 
 #### Returns
 
-`Promise`<`any`[]\>
+`Promise`\<`any`[]\>
 
 #### Inherited from
 
@@ -703,7 +703,7 @@ EventEmitter.once
 
 node_modules/@types/node/events.d.ts:21
 
-▸ `Static` **once**(`emitter`, `event`): `Promise`<`any`[]\>
+▸ `Static` **once**(`emitter`, `event`): `Promise`\<`any`[]\>
 
 #### Parameters
 
@@ -714,7 +714,7 @@ node_modules/@types/node/events.d.ts:21
 
 #### Returns
 
-`Promise`<`any`[]\>
+`Promise`\<`any`[]\>
 
 #### Inherited from
 

diff --git a/docs/api/classes/SessionTranscriber.md b/docs/api/classes/SessionTranscriber.md
@@ -510,10 +510,6 @@ ___
 
 ▸ `Static` **listenerCount**(`emitter`, `event`): `number`
 
-**`Deprecated`**
-
-since v4.0.0
-
 #### Parameters
 
 | Name | Type |
@@ -525,6 +521,10 @@ since v4.0.0
 
 `number`
 
+**`Deprecated`**
+
+since v4.0.0
+
 #### Inherited from
 
 EventEmitter.listenerCount
@@ -537,7 +537,7 @@ ___
 
 ### on
 
-▸ `Static` **on**(`emitter`, `event`): `AsyncIterableIterator`<`any`\>
+▸ `Static` **on**(`emitter`, `event`): `AsyncIterableIterator`\<`any`\>
 
 #### Parameters
 
@@ -548,7 +548,7 @@ ___
 
 #### Returns
 
-`AsyncIterableIterator`<`any`\>
+`AsyncIterableIterator`\<`any`\>
 
 #### Inherited from
 
@@ -562,7 +562,7 @@ ___
 
 ### once
 
-▸ `Static` **once**(`emitter`, `event`): `Promise`<`any`[]\>
+▸ `Static` **once**(`emitter`, `event`): `Promise`\<`any`[]\>
 
 #### Parameters
 
@@ -573,7 +573,7 @@ ___
 
 #### Returns
 
-`Promise`<`any`[]\>
+`Promise`\<`any`[]\>
 
 #### Inherited from
 
@@ -583,7 +583,7 @@ EventEmitter.once
 
 node_modules/@types/node/events.d.ts:21
 
-▸ `Static` **once**(`emitter`, `event`): `Promise`<`any`[]\>
+▸ `Static` **once**(`emitter`, `event`): `Promise`\<`any`[]\>
 
 #### Parameters
 
@@ -594,7 +594,7 @@ node_modules/@types/node/events.d.ts:21
 
 #### Returns
 
-`Promise`<`any`[]\>
+`Promise`\<`any`[]\>
 
 #### Inherited from
 

diff --git a/docs/api/classes/TimeoutWaitingForResponseError.md b/docs/api/classes/TimeoutWaitingForResponseError.md
@@ -108,10 +108,6 @@ ___
 
 Optional override for formatting stack traces
 
-**`See`**
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
 ##### Parameters
 
 | Name | Type |
@@ -123,6 +119,10 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 `any`
 
+**`See`**
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
 #### Inherited from
 
 Error.prepareStackTrace

diff --git a/docs/api/classes/WebMessageServerConnectionFixture.md b/docs/api/classes/WebMessageServerConnectionFixture.md
@@ -113,11 +113,11 @@ ___
 
 ### waitForConnectionToClose
 
-▸ **waitForConnectionToClose**(): `Promise`<`void`\>
+▸ **waitForConnectionToClose**(): `Promise`\<`void`\>
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Defined in
 
@@ -127,11 +127,11 @@ ___
 
 ### waitForMessage
 
-▸ **waitForMessage**(): `Promise`<`any`\>
+▸ **waitForMessage**(): `Promise`\<`any`\>
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`\<`any`\>
 
 #### Defined in
 

diff --git a/docs/api/classes/WebMessageServerFixture.md b/docs/api/classes/WebMessageServerFixture.md
@@ -61,11 +61,11 @@ ___
 
 ### waitForConnection
 
-▸ **waitForConnection**(): `Promise`<[`WebMessageServerConnectionFixture`](WebMessageServerConnectionFixture.md)\>
+▸ **waitForConnection**(): `Promise`\<[`WebMessageServerConnectionFixture`](WebMessageServerConnectionFixture.md)\>
 
 #### Returns
 
-`Promise`<[`WebMessageServerConnectionFixture`](WebMessageServerConnectionFixture.md)\>
+`Promise`\<[`WebMessageServerConnectionFixture`](WebMessageServerConnectionFixture.md)\>
 
 #### Defined in