@isdk/ai-tool 0.5.2 → 0.5.3

package/docs/interfaces/ServerFuncParams.md

@@ -0,0 +1,35 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ServerFuncParams
+
+# Interface: ServerFuncParams
+
+Defined in: [packages/ai-tool/src/server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L8)
+
+Convention: Always pass _req, _res
+
+## Extended by
+
+- [`EventServerFuncParams`](EventServerFuncParams.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### \_req?
+
+> `optional` **\_req**: `IncomingMessage`
+
+Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L9)
+
+***
+
+### \_res?
+
+> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
+
+Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L10)

package/docs/interfaces/SplitSentenceOptions.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SplitSentenceOptions
+
+# Interface: SplitSentenceOptions
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L25)
+
+## Properties
+
+### best?
+
+> `optional` **best**: `boolean`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L26)
+
+***
+
+### completeSentence?
+
+> `optional` **completeSentence**: `boolean`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L27)
+
+***
+
+### ignoreEmptyLine?
+
+> `optional` **ignoreEmptyLine**: `boolean`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L29)
+
+***
+
+### isMarkdown?
+
+> `optional` **isMarkdown**: `boolean`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L28)

package/docs/interfaces/StreamCallbacksAndOptions.md

@@ -0,0 +1,99 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / StreamCallbacksAndOptions
+
+# Interface: StreamCallbacksAndOptions\<I, O\>
+
+Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L5)
+
+Configuration options and helper callback methods for stream lifecycle events.
+
+## Type Parameters
+
+• **I** = `any`
+
+• **O** = `any`
+
+## Properties
+
+### onError()?
+
+> `optional` **onError**: (`error`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L12)
+
+#### Parameters
+
+##### error
+
+`Error`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### onFinal()?
+
+> `optional` **onFinal**: (`controller`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L11)
+
+`onFinal`: Called once when the stream is closed with the final completion message.
+
+#### Parameters
+
+##### controller
+
+`TransformStreamDefaultController`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### onStart()?
+
+> `optional` **onStart**: (`controller`) => `void` \| `Promise`\<`void`\>
+
+Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L7)
+
+`onStart`: Called once when the stream is initialized.
+
+#### Parameters
+
+##### controller
+
+`TransformStreamDefaultController`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### onTransform()?
+
+> `optional` **onTransform**: (`chunk`, `controller`) => `void` \| `O` \| `Promise`\<`void` \| `O`\>
+
+Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L9)
+
+`onToken`: Called for each tokenized message.
+
+#### Parameters
+
+##### chunk
+
+`I`
+
+##### controller
+
+`TransformStreamDefaultController`
+
+#### Returns
+
+`void` \| `O` \| `Promise`\<`void` \| `O`\>

package/docs/interfaces/TaskAbortControllers.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / TaskAbortControllers
+
+# Interface: TaskAbortControllers
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L66)
+
+## Indexable
+
+\[`k`: `string` \| `number`\]: `undefined` \| [`TaskAbortController`](../classes/TaskAbortController.md)

package/docs/interfaces/TaskPromise.md

@@ -0,0 +1,138 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / TaskPromise
+
+# Interface: TaskPromise\<T\>
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:70](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L70)
+
+## Extends
+
+- `Promise`\<`T`\>
+
+## Type Parameters
+
+• **T** = `any`
+
+## Properties
+
+### \[toStringTag\]
+
+> `readonly` **\[toStringTag\]**: `string`
+
+Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:176
+
+#### Inherited from
+
+`Promise.[toStringTag]`
+
+***
+
+### task?
+
+> `optional` **task**: [`TaskAbortController`](../classes/TaskAbortController.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:71](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L71)
+
+## Methods
+
+### catch()
+
+> **catch**\<`TResult`\>(`onrejected`?): `Promise`\<`T` \| `TResult`\>
+
+Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1557
+
+Attaches a callback for only the rejection of the Promise.
+
+#### Type Parameters
+
+• **TResult** = `never`
+
+#### Parameters
+
+##### onrejected?
+
+The callback to execute when the Promise is rejected.
+
+`null` | (`reason`) => `TResult` \| `PromiseLike`\<`TResult`\>
+
+#### Returns
+
+`Promise`\<`T` \| `TResult`\>
+
+A Promise for the completion of the callback.
+
+#### Inherited from
+
+`Promise.catch`
+
+***
+
+### finally()
+
+> **finally**(`onfinally`?): `Promise`\<`T`\>
+
+Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2018.promise.d.ts:29
+
+Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
+resolved value cannot be modified from the callback.
+
+#### Parameters
+
+##### onfinally?
+
+The callback to execute when the Promise is settled (fulfilled or rejected).
+
+`null` | () => `void`
+
+#### Returns
+
+`Promise`\<`T`\>
+
+A Promise for the completion of the callback.
+
+#### Inherited from
+
+`Promise.finally`
+
+***
+
+### then()
+
+> **then**\<`TResult1`, `TResult2`\>(`onfulfilled`?, `onrejected`?): `Promise`\<`TResult1` \| `TResult2`\>
+
+Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1550
+
+Attaches callbacks for the resolution and/or rejection of the Promise.
+
+#### Type Parameters
+
+• **TResult1** = `T`
+
+• **TResult2** = `never`
+
+#### Parameters
+
+##### onfulfilled?
+
+The callback to execute when the Promise is resolved.
+
+`null` | (`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>
+
+##### onrejected?
+
+The callback to execute when the Promise is rejected.
+
+`null` | (`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>
+
+#### Returns
+
+`Promise`\<`TResult1` \| `TResult2`\>
+
+A Promise for the completion of which ever callback is executed.
+
+#### Inherited from
+
+`Promise.then`

package/docs/interfaces/ToolFuncPackage.md

@@ -0,0 +1,47 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolFuncPackage
+
+# Interface: ToolFuncPackage
+
+Defined in: [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L45)
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L46)
+
+***
+
+### register()
+
+> **register**: (`data`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L47)
+
+#### Parameters
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### unregister()?
+
+> `optional` **unregister**: () => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L48)
+
+#### Returns
+
+`void`

package/docs/namespaces/EventStates/README.md

@@ -0,0 +1,14 @@
+[**@isdk/ai-tool**](../../README.md)
+
+***
+
+[@isdk/ai-tool](../../globals.md) / EventStates
+
+# EventStates
+
+## Variables
+
+- [ABORT](variables/ABORT.md)
+- [CONTINUE](variables/CONTINUE.md)
+- [DONE](variables/DONE.md)
+- [STOPPED](variables/STOPPED.md)

package/docs/namespaces/EventStates/variables/ABORT.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../../../README.md)
+
+***
+
+[@isdk/ai-tool](../../../globals.md) / [EventStates](../README.md) / ABORT
+
+# Variable: ABORT
+
+> `const` **ABORT**: `-1`
+
+Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/consts.d.ts:11

package/docs/namespaces/EventStates/variables/CONTINUE.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../../../README.md)
+
+***
+
+[@isdk/ai-tool](../../../globals.md) / [EventStates](../README.md) / CONTINUE
+
+# Variable: CONTINUE
+
+> `const` **CONTINUE**: `any`
+
+Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/consts.d.ts:8

package/docs/namespaces/EventStates/variables/DONE.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../../../README.md)
+
+***
+
+[@isdk/ai-tool](../../../globals.md) / [EventStates](../README.md) / DONE
+
+# Variable: DONE
+
+> `const` **DONE**: `1`
+
+Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/consts.d.ts:9

package/docs/namespaces/EventStates/variables/STOPPED.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../../../README.md)
+
+***
+
+[@isdk/ai-tool](../../../globals.md) / [EventStates](../README.md) / STOPPED
+
+# Variable: STOPPED
+
+> `const` **STOPPED**: `2`
+
+Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/consts.d.ts:10

package/docs/namespaces/uuidv5/README.md

@@ -0,0 +1,12 @@
+[**@isdk/ai-tool**](../../README.md)
+
+***
+
+[@isdk/ai-tool](../../globals.md) / uuidv5
+
+# uuidv5
+
+## Variables
+
+- [DNS](variables/DNS.md)
+- [URL](variables/URL.md)

package/docs/namespaces/uuidv5/variables/DNS.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../../../README.md)
+
+***
+
+[@isdk/ai-tool](../../../globals.md) / [uuidv5](../README.md) / DNS
+
+# Variable: DNS
+
+> **DNS**: `string`
+
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v5.d.ts:6

package/docs/namespaces/uuidv5/variables/URL.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../../../README.md)
+
+***
+
+[@isdk/ai-tool](../../../globals.md) / [uuidv5](../README.md) / URL
+
+# Variable: URL
+
+> **URL**: `string`
+
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v5.d.ts:7

package/docs/type-aliases/AIChatContentPart.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChatContentPart
+
+# Type Alias: AIChatContentPart
+
+> **AIChatContentPart**: [`AIChatContentPartText`](../interfaces/AIChatContentPartText.md) \| [`AIChatContentPartImage`](../interfaces/AIChatContentPartImage.md)
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:82](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L82)

package/docs/type-aliases/AIChatMessageParam.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChatMessageParam
+
+# Type Alias: AIChatMessageParam
+
+> **AIChatMessageParam**: [`AIChatMessageParamBase`](../interfaces/AIChatMessageParamBase.md) \| [`AIChatSystemMessageParam`](../interfaces/AIChatSystemMessageParam.md) \| [`AIChatUserMessageParam`](../interfaces/AIChatUserMessageParam.md) \| [`AIChatAssistantMessageParam`](../interfaces/AIChatAssistantMessageParam.md) \| [`AIChatToolMessageParam`](../interfaces/AIChatToolMessageParam.md)
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:46](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L46)

package/docs/type-aliases/AIChatRole.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChatRole
+
+# Type Alias: AIChatRole
+
+> **AIChatRole**: *typeof* [`AIChatRoles`](../variables/AIChatRoles.md)\[`number`\] & `string`
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:44](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L44)

package/docs/type-aliases/AIChatToolChoiceParam.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChatToolChoiceParam
+
+# Type Alias: AIChatToolChoiceParam
+
+> **AIChatToolChoiceParam**: `"auto"` \| `"none"` \| `"required"` \| [`AIChatToolChoiceObject`](../interfaces/AIChatToolChoiceObject.md)
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:141](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L141)

package/docs/type-aliases/AIMessageType.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIMessageType
+
+# Type Alias: AIMessageType
+
+> **AIMessageType**: *typeof* [`AIMessageTypes`](../variables/AIMessageTypes.md)\[`number`\]
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:38](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L38)

package/docs/type-aliases/AIModelNameRule.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIModelNameRule
+
+# Type Alias: AIModelNameRule
+
+> **AIModelNameRule**: `string` \| `RegExp` \| [`AIModelNameRuleFn`](AIModelNameRuleFn.md)
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L10)

package/docs/type-aliases/AIModelNameRuleFn.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIModelNameRuleFn
+
+# Type Alias: AIModelNameRuleFn()
+
+> **AIModelNameRuleFn**: (`name`) => `string` \| `RegExpExecArray` \| `undefined`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L8)
+
+## Parameters
+
+### name
+
+`string`
+
+## Returns
+
+`string` \| `RegExpExecArray` \| `undefined`

package/docs/type-aliases/AIModelNameRules.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIModelNameRules
+
+# Type Alias: AIModelNameRules
+
+> **AIModelNameRules**: [`AIModelNameRule`](AIModelNameRule.md) \| [`AIModelNameRule`](AIModelNameRule.md)[]
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L11)

package/docs/type-aliases/AITextGenerationFinishReason.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AITextGenerationFinishReason
+
+# Type Alias: AITextGenerationFinishReason
+
+> **AITextGenerationFinishReason**: *typeof* [`AITextGenerationFinishReasons`](../variables/AITextGenerationFinishReasons.md)\[`number`\]
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L14)

package/docs/type-aliases/ActionName.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ActionName
+
+# Type Alias: ActionName
+
+> **ActionName**: *typeof* [`ActionNames`](../variables/ActionNames.md)\[`number`\]
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L6)

package/docs/type-aliases/AsyncTaskId.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AsyncTaskId
+
+# Type Alias: AsyncTaskId
+
+> **AsyncTaskId**: `string` \| `number`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L27)

package/docs/type-aliases/BeforeShutdownListener.md

@@ -0,0 +1,23 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / BeforeShutdownListener
+
+# Type Alias: BeforeShutdownListener()
+
+> **BeforeShutdownListener**: (`signalOrEvent`) => `Promise`\<`void`\> \| `void`
+
+Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/node/before-shutdown.ts#L13)
+
+## Parameters
+
+### signalOrEvent
+
+`string`
+
+The exit signal or event name received on the process.
+
+## Returns
+
+`Promise`\<`void`\> \| `void`