@isdk/ai-tool 0.0.7 → 0.0.8

package/docs/classes/AlreadyExistsError.md

@@ -66,7 +66,7 @@ throw new AlreadyExistsError('user', { id: 123 })
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:193](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L193)
+[packages/ai-tool/src/utils/base-error.ts:195](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L195)
 
 ## Properties
 
@@ -82,7 +82,7 @@ The name of the function that threw the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:64](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L64)
+[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L66)
 
 ___
 
@@ -110,7 +110,7 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:65](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L65)
+[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L67)
 
 ___
 
@@ -126,7 +126,7 @@ Additional data associated with the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L66)
+[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L68)
 
 ___
 
@@ -184,7 +184,7 @@ The error code associated with the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:192](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L192)
+[packages/ai-tool/src/utils/base-error.ts:194](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L194)
 
 ___
 
@@ -261,7 +261,7 @@ A new BaseError instance.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:129](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L129)
+[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L131)
 
 ___
 
@@ -283,7 +283,7 @@ A JSON representation of the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:109](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L109)
+[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L111)
 
 ___
 
@@ -336,4 +336,4 @@ typeof [`BaseError`](BaseError.md)
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L68)
+[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L70)

package/docs/classes/BaseError.md

@@ -93,7 +93,7 @@ AbstractError.constructor
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:79](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L79)
+[packages/ai-tool/src/utils/base-error.ts:81](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L81)
 
 ## Properties
 
@@ -105,7 +105,7 @@ The name of the function that threw the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:64](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L64)
+[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L66)
 
 ___
 
@@ -133,7 +133,7 @@ AbstractError.code
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:65](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L65)
+[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L67)
 
 ___
 
@@ -145,7 +145,7 @@ Additional data associated with the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L66)
+[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L68)
 
 ___
 
@@ -199,7 +199,7 @@ The error code associated with the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:63](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L63)
+[packages/ai-tool/src/utils/base-error.ts:65](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L65)
 
 ___
 
@@ -272,7 +272,7 @@ A new BaseError instance.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:129](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L129)
+[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L131)
 
 ___
 
@@ -290,7 +290,7 @@ A JSON representation of the error.
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:109](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L109)
+[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L111)
 
 ___
 
@@ -343,4 +343,4 @@ AbstractError.createErrorClass
 
 #### Defined in
 
-[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/base-error.ts#L68)
+[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/base-error.ts#L70)

package/docs/classes/CancelableAbility.md

@@ -0,0 +1,431 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / CancelableAbility
+
+# Class: CancelableAbility
+
+## Indexable
+
+▪ [name: `string`]: `any`
+
+## Table of contents
+
+### Constructors
+
+- [constructor](CancelableAbility.md#constructor)
+
+### Properties
+
+- [\_\_task\_aborter](CancelableAbility.md#__task_aborter)
+- [\_\_task\_semaphore](CancelableAbility.md#__task_semaphore)
+- [\_asyncFeatures](CancelableAbility.md#_asyncfeatures)
+- [\_maxTaskConcurrency](CancelableAbility.md#_maxtaskconcurrency)
+- [cleanMultiTaskAborter](CancelableAbility.md#cleanmultitaskaborter)
+- [generateAsyncTaskId](CancelableAbility.md#generateasynctaskid)
+
+### Accessors
+
+- [maxTaskConcurrency](CancelableAbility.md#maxtaskconcurrency)
+- [semaphore](CancelableAbility.md#semaphore)
+
+### Methods
+
+- [$cleanMultiTaskAborter](CancelableAbility.md#$cleanmultitaskaborter)
+- [$generateAsyncTaskId](CancelableAbility.md#$generateasynctaskid)
+- [\_cleanMultiTaskAborter](CancelableAbility.md#_cleanmultitaskaborter)
+- [\_generateAsyncTaskId](CancelableAbility.md#_generateasynctaskid)
+- [abort](CancelableAbility.md#abort)
+- [cleanTaskAborter](CancelableAbility.md#cleantaskaborter)
+- [createAborter](CancelableAbility.md#createaborter)
+- [createTaskPromise](CancelableAbility.md#createtaskpromise)
+- [getRunningTask](CancelableAbility.md#getrunningtask)
+- [getRunningTaskCount](CancelableAbility.md#getrunningtaskcount)
+- [isAborted](CancelableAbility.md#isaborted)
+- [runAsyncCancelableTask](CancelableAbility.md#runasynccancelabletask)
+
+## Constructors
+
+### constructor
+
+• **new CancelableAbility**(): [`CancelableAbility`](CancelableAbility.md)
+
+#### Returns
+
+[`CancelableAbility`](CancelableAbility.md)
+
+## Properties
+
+### \_\_task\_aborter
+
+• **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:65](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L65)
+
+___
+
+### \_\_task\_semaphore
+
+• **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L66)
+
+___
+
+### \_asyncFeatures
+
+• `Optional` **\_asyncFeatures**: `number`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L55)
+
+___
+
+### \_maxTaskConcurrency
+
+• **\_maxTaskConcurrency**: `undefined` \| `number`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:56](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L56)
+
+___
+
+### cleanMultiTaskAborter
+
+• **cleanMultiTaskAborter**: (`id`: [`AsyncTaskId`](../modules.md#asynctaskid), `aborters`: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)) => `void`
+
+#### Type declaration
+
+▸ (`id`, `aborters`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+| `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:63](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L63)
+
+___
+
+### generateAsyncTaskId
+
+• **generateAsyncTaskId**: (`taskId?`: [`AsyncTaskId`](../modules.md#asynctaskid), `aborters?`: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)) => [`AsyncTaskId`](../modules.md#asynctaskid)
+
+#### Type declaration
+
+▸ (`taskId?`, `aborters?`): [`AsyncTaskId`](../modules.md#asynctaskid)
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+| `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
+
+##### Returns
+
+[`AsyncTaskId`](../modules.md#asynctaskid)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:62](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L62)
+
+## Accessors
+
+### maxTaskConcurrency
+
+• `get` **maxTaskConcurrency**(): `undefined` \| `number`
+
+#### Returns
+
+`undefined` \| `number`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:68](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L68)
+
+___
+
+### semaphore
+
+• `get` **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
+
+#### Returns
+
+`undefined` \| [`Semaphore`](Semaphore.md)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:72](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L72)
+
+## Methods
+
+### $cleanMultiTaskAborter
+
+▸ **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+| `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:214](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L214)
+
+___
+
+### $generateAsyncTaskId
+
+▸ **$generateAsyncTaskId**(`taskId?`, `aborters?`): `undefined` \| [`AsyncTaskId`](../modules.md#asynctaskid)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+| `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
+
+#### Returns
+
+`undefined` \| [`AsyncTaskId`](../modules.md#asynctaskid)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:147](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L147)
+
+___
+
+### \_cleanMultiTaskAborter
+
+▸ **_cleanMultiTaskAborter**(`id`, `aborters`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+| `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:234](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L234)
+
+___
+
+### \_generateAsyncTaskId
+
+▸ **_generateAsyncTaskId**(`taskId?`, `aborters?`): [`AsyncTaskId`](../modules.md#asynctaskid)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+| `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
+
+#### Returns
+
+[`AsyncTaskId`](../modules.md#asynctaskid)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:134](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L134)
+
+___
+
+### abort
+
+▸ **abort**(`reason?`, `data?`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `reason?` | `string` |
+| `data?` | `any` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:291](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L291)
+
+___
+
+### cleanTaskAborter
+
+▸ **cleanTaskAborter**(`aborter`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `aborter` | [`TaskAbortController`](TaskAbortController.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:224](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L224)
+
+___
+
+### createAborter
+
+▸ **createAborter**(`params?`, `taskId?`, `raiseError?`): [`TaskAbortController`](TaskAbortController.md)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `params?` | `any` | `undefined` |
+| `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) | `undefined` |
+| `raiseError` | `boolean` | `true` |
+
+#### Returns
+
+[`TaskAbortController`](TaskAbortController.md)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L158)
+
+___
+
+### createTaskPromise
+
+▸ **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options?`): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Output` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `runTask` | (`params`: `Record`\<`string`, `any`\>, `aborter`: [`TaskAbortController`](TaskAbortController.md)) => `Promise`\<`Output`\> |
+| `params` | `Record`\<`string`, `any`\> |
+| `options?` | `Object` |
+| `options.raiseError?` | `boolean` |
+| `options.taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+
+#### Returns
+
+[`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:238](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L238)
+
+___
+
+### getRunningTask
+
+▸ **getRunningTask**(`taskId?`): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+
+#### Returns
+
+`undefined` \| [`TaskAbortController`](TaskAbortController.md)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:96](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L96)
+
+___
+
+### getRunningTaskCount
+
+▸ **getRunningTaskCount**(): `number`
+
+#### Returns
+
+`number`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:119](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L119)
+
+___
+
+### isAborted
+
+▸ **isAborted**(`taskId?`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:81](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L81)
+
+___
+
+### runAsyncCancelableTask
+
+▸ **runAsyncCancelableTask**\<`Output`\>(`params?`, `runTask`, `options?`): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+#### Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Output` | `any` |
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `params` | `Record`\<`string`, `any`\> |
+| `runTask` | (`params`: `Record`\<`string`, `any`\>, `aborter`: [`TaskAbortController`](TaskAbortController.md)) => `Promise`\<`Output`\> |
+| `options?` | `Object` |
+| `options.raiseError?` | `boolean` |
+| `options.taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
+
+#### Returns
+
+[`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/cancelable-ability.ts:276](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L276)