@isdk/ai-tool 0.5.1 → 0.5.2

package/docs/classes/SignalGate.md

@@ -1,182 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / SignalGate
-
-# Class: SignalGate\<T\>
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:20](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L20)
-
-An asynchronous signal gate that blocks operations until a signal is emitted.
-This class allows multiple awaiters to wait for a signal and resolves all pending promises with the emitted value.
-The gate can be reset to reuse for subsequent signals.
-
-## Example
-
-```typescript
-// Default type is void, can call signal() without parameters
-const gate = new SignalGate();
-gate.signal(); // No parameters required
-
-// Example with explicit type
-const valueGate = new SignalGate<number>();
-valueGate.signal(42); // Must provide a number value
-```
-
-## Type Parameters
-
-• **T** = `void`
-
-## Constructors
-
-### new SignalGate()
-
-> **new SignalGate**\<`T`\>(): [`SignalGate`](SignalGate.md)\<`T`\>
-
-#### Returns
-
-[`SignalGate`](SignalGate.md)\<`T`\>
-
-## Properties
-
-### \_isSignaled
-
-> `protected` **\_isSignaled**: `boolean` = `false`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L21)
-
-***
-
-### \_signalValue
-
-> `protected` **\_signalValue**: `undefined` \| `T`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:22](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L22)
-
-***
-
-### waitQueue
-
-> `protected` **waitQueue**: `object`[] = `[]`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:23](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L23)
-
-#### reject()
-
-> **reject**: (`error`) => `void`
-
-##### Parameters
-
-###### error
-
-`any`
-
-##### Returns
-
-`void`
-
-#### resolve()
-
-> **resolve**: (`value`) => `void`
-
-##### Parameters
-
-###### value
-
-`T`
-
-##### Returns
-
-`void`
-
-## Accessors
-
-### signaled
-
-#### Get Signature
-
-> **get** **signaled**(): `boolean`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:28](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L28)
-
-##### Returns
-
-`boolean`
-
-## Methods
-
-### abort()
-
-> **abort**(`reason`?): `void`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:65](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L65)
-
-Aborts all pending waits, rejecting their promises with an error.
-This does **not** reset the signal state (the gate remains signaled or unsignaled).
-
-#### Parameters
-
-##### reason?
-
-`any`
-
-The reason for aborting the waits.
-
-#### Returns
-
-`void`
-
-***
-
-### reset()
-
-> **reset**(): `void`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:53](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L53)
-
-Resets the gate to its initial state, allowing a new signal to be emitted.
-
-#### Returns
-
-`void`
-
-***
-
-### signal()
-
-> **signal**(`value`?): `void`
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:38](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L38)
-
-Emits the signal with an optional value, resolving all pending [wait](../functions/wait.md) promises.
-Subsequent calls have no effect until [reset](SignalGate.md#reset) is called.
-
-#### Parameters
-
-##### value?
-
-`T`
-
-The value to emit with the signal (only required if T is not void).
-
-#### Returns
-
-`void`
-
-***
-
-### wait()
-
-> **wait**(): `Promise`\<`T`\>
-
-Defined in: [packages/ai-tool/src/utils/async-signal-gate.ts:83](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/async-signal-gate.ts#L83)
-
-Returns a promise that resolves with the emitted signal value.
-If called after the signal has been emitted, resolves immediately with the stored value.
-
-#### Returns
-
-`Promise`\<`T`\>
-
-A promise resolving to the signal value (type T).

package/docs/classes/TaskAbortController.md

@@ -1,131 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / TaskAbortController
-
-# Class: TaskAbortController
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:35](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L35)
-
-## Extends
-
-- `AbortController`
-
-## Constructors
-
-### new TaskAbortController()
-
-> **new TaskAbortController**(`parent`): [`TaskAbortController`](TaskAbortController.md)
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:41](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L41)
-
-#### Parameters
-
-##### parent
-
-[`CancelableAbility`](CancelableAbility.md)
-
-#### Returns
-
-[`TaskAbortController`](TaskAbortController.md)
-
-#### Overrides
-
-`AbortController.constructor`
-
-## Properties
-
-### id?
-
-> `optional` **id**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:36](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L36)
-
-***
-
-### parent
-
-> **parent**: [`CancelableAbility`](CancelableAbility.md)
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:39](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L39)
-
-***
-
-### signal
-
-> `readonly` **signal**: `AbortSignal`
-
-Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/lib.dom.d.ts:2501
-
-Returns the AbortSignal object associated with this object.
-
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/signal)
-
-#### Inherited from
-
-`AbortController.signal`
-
-***
-
-### streamController?
-
-> `optional` **streamController**: `ReadableStreamDefaultController`\<`any`\>
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:38](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L38)
-
-***
-
-### timeoutId?
-
-> `optional` **timeoutId**: `any`
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:37](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L37)
-
-## Methods
-
-### abort()
-
-> **abort**(`reason`?, `data`?): `void`
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:46](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L46)
-
-Invoking this method will set this object's AbortSignal's aborted flag and signal to any observers that the associated activity is to be aborted.
-
-[MDN Reference](https://developer.mozilla.org/docs/Web/API/AbortController/abort)
-
-#### Parameters
-
-##### reason?
-
-`string` | `Error` | [`CommonError`](CommonError.md)
-
-##### data?
-
-`any`
-
-#### Returns
-
-`void`
-
-#### Overrides
-
-`AbortController.abort`
-
-***
-
-### throwRejected()
-
-> **throwRejected**(`alreadyRejected`?): `undefined` \| `true`
-
-Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L55)
-
-#### Parameters
-
-##### alreadyRejected?
-
-`boolean`
-
-#### Returns
-
-`undefined` \| `true`