@isdk/ai-tool 0.5.2 → 0.5.4

package/docs/classes/CancelableAbility.md

@@ -0,0 +1,467 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / CancelableAbility
+
+# Class: CancelableAbility
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:74](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L74)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Constructors
+
+### new CancelableAbility()
+
+> **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:86](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L86)
+
+***
+
+### \_\_task\_semaphore
+
+> **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:87](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L87)
+
+***
+
+### \_asyncFeatures?
+
+> `optional` **\_asyncFeatures**: `number`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:75](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L75)
+
+***
+
+### \_isReadyFn?
+
+> `optional` **\_isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:77](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L77)
+
+***
+
+### \_maxTaskConcurrency
+
+> **\_maxTaskConcurrency**: `undefined` \| `number`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:76](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L76)
+
+***
+
+### cleanMultiTaskAborter()
+
+> **cleanMultiTaskAborter**: (`id`, `aborters`) => `void`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:84](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L84)
+
+#### Parameters
+
+##### id
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### aborters
+
+[`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Returns
+
+`void`
+
+***
+
+### generateAsyncTaskId()
+
+> **generateAsyncTaskId**: (`taskId`?, `aborters`?) => [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:83](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L83)
+
+#### Parameters
+
+##### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### aborters?
+
+[`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Returns
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+## Accessors
+
+### maxTaskConcurrency
+
+#### Get Signature
+
+> **get** **maxTaskConcurrency**(): `undefined` \| `number`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:89](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L89)
+
+##### Returns
+
+`undefined` \| `number`
+
+***
+
+### semaphore
+
+#### Get Signature
+
+> **get** **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:93](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L93)
+
+##### Returns
+
+`undefined` \| [`Semaphore`](Semaphore.md)
+
+## Methods
+
+### \_cleanMultiTaskAborter()
+
+> **\_cleanMultiTaskAborter**(`id`, `aborters`): `void`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:273](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L273)
+
+#### Parameters
+
+##### id
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### aborters
+
+[`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Returns
+
+`void`
+
+***
+
+### \_generateAsyncTaskId()
+
+> **\_generateAsyncTaskId**(`taskId`?, `aborters`?): [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:173](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L173)
+
+#### Parameters
+
+##### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### aborters?
+
+[`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Returns
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+***
+
+### $cleanMultiTaskAborter()
+
+> **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:253](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L253)
+
+#### Parameters
+
+##### id
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### aborters
+
+[`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Returns
+
+`void`
+
+***
+
+### $generateAsyncTaskId()
+
+> **$generateAsyncTaskId**(`taskId`?, `aborters`?): `undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:186](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L186)
+
+#### Parameters
+
+##### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### aborters?
+
+[`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
+
+#### Returns
+
+`undefined` \| [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+***
+
+### abort()
+
+> **abort**(`reason`?, `data`?): `void`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:330](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L330)
+
+#### Parameters
+
+##### reason?
+
+`string`
+
+##### data?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### cleanTaskAborter()
+
+> **cleanTaskAborter**(`aborter`): `void`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:263](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L263)
+
+#### Parameters
+
+##### aborter
+
+[`TaskAbortController`](TaskAbortController.md)
+
+#### Returns
+
+`void`
+
+***
+
+### createAborter()
+
+> **createAborter**(`params`?, `taskId`?, `raiseError`?): [`TaskAbortController`](TaskAbortController.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:197](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L197)
+
+#### Parameters
+
+##### params?
+
+`any`
+
+##### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+##### raiseError?
+
+`boolean` = `true`
+
+#### Returns
+
+[`TaskAbortController`](TaskAbortController.md)
+
+***
+
+### createTaskPromise()
+
+> **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:277](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L277)
+
+#### Type Parameters
+
+• **Output** = `any`
+
+#### Parameters
+
+##### runTask
+
+(`params`, `aborter`) => `Promise`\<`Output`\>
+
+##### params
+
+`Record`\<`string`, `any`\>
+
+##### options?
+
+###### raiseError?
+
+`boolean`
+
+###### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+#### Returns
+
+[`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+***
+
+### getRunningTask()
+
+> **getRunningTask**(`taskId`?): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:135](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L135)
+
+#### Parameters
+
+##### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+#### Returns
+
+`undefined` \| [`TaskAbortController`](TaskAbortController.md)
+
+***
+
+### getRunningTaskCount()
+
+> **getRunningTaskCount**(): `number`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L158)
+
+#### Returns
+
+`number`
+
+***
+
+### getSemaphore()
+
+> **getSemaphore**(`isReadyFn`): `undefined` \| [`Semaphore`](Semaphore.md)
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:97](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L97)
+
+#### Parameters
+
+##### isReadyFn
+
+`undefined` | [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
+
+#### Returns
+
+`undefined` \| [`Semaphore`](Semaphore.md)
+
+***
+
+### hasAsyncFeature()
+
+> **hasAsyncFeature**(`feature`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:114](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L114)
+
+#### Parameters
+
+##### feature
+
+[`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
+
+#### Returns
+
+`boolean`
+
+***
+
+### isAborted()
+
+> **isAborted**(`taskId`?): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L120)
+
+#### Parameters
+
+##### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+#### Returns
+
+`boolean`
+
+***
+
+### runAsyncCancelableTask()
+
+> **runAsyncCancelableTask**\<`Output`\>(`params`, `runTask`, `options`?): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:315](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L315)
+
+#### Type Parameters
+
+• **Output** = `any`
+
+#### Parameters
+
+##### params
+
+`Record`\<`string`, `any`\> = `{}`
+
+##### runTask
+
+(`params`, `aborter`) => `Promise`\<`Output`\>
+
+##### options?
+
+###### isReadyFn?
+
+[`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
+
+###### raiseError?
+
+`boolean`
+
+###### taskId?
+
+[`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
+
+#### Returns
+
+[`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
+
+***
+
+### hasAsyncFeature()
+
+> `static` **hasAsyncFeature**(`feature`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:107](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L107)
+
+#### Parameters
+
+##### feature
+
+[`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
+
+#### Returns
+
+`boolean`