@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/classes/SSEChannel.md

@@ -1,270 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / SSEChannel
-
-# Class: SSEChannel
-
-A class for creating Server-Sent Events (SSE) channels.
-
-## Example
-
-```ts
-const sseChannel = new SSEChannel({ pingInterval: 5000 })
-sseChannel.publish('Hello, world!', 'greeting')
-```
-
-## Constructors
-
-### new SSEChannel()
-
-> **new SSEChannel**(`options`?): [`SSEChannel`](SSEChannel.md)
-
-Creates a new SSE channel.
-
-#### Parameters
-
-• **options?**: `Record`\<`string`, `any`\>
-
-The options for the SSE channel.
-
-#### Returns
-
-[`SSEChannel`](SSEChannel.md)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:65](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L65)
-
-## Properties
-
-### \_active
-
-> **\_active**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:26](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L26)
-
-***
-
-### clients
-
-> **clients**: `Set`\<`Client`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:27](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L27)
-
-***
-
-### messages
-
-> **messages**: `Record`\<`string`, `any`\>[]
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:28](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L28)
-
-***
-
-### nextID
-
-> **nextID**: `number`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L29)
-
-***
-
-### options
-
-> **options**: `Record`\<`string`, `any`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:30](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L30)
-
-***
-
-### pingTimer?
-
-> `optional` **pingTimer**: `Timeout`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:31](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L31)
-
-## Accessors
-
-### active
-
-> `get` **active**(): `boolean`
-
-> `set` **active**(`v`): `void`
-
-#### Parameters
-
-• **v**: `boolean`
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:33](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L33)
-
-## Methods
-
-### clearClients()
-
-> **clearClients**(): `void`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:195](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L195)
-
-***
-
-### getSubscriberCount()
-
-> **getSubscriberCount**(): `number`
-
-Gets the number of clients subscribed to the SSE channel.
-
-#### Returns
-
-`number`
-
-- Returns the number of clients.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:220](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L220)
-
-***
-
-### listClients()
-
-> **listClients**(): `Record`\<`string`, `number`\>
-
-Lists the clients connected to the SSE channel grouped by IP address.
-
-#### Returns
-
-`Record`\<`string`, `number`\>
-
-- Returns an object where the keys are the IP addresses and the values are the number of clients connected from each IP.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:204](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L204)
-
-***
-
-### publish()
-
-> **publish**(`data`?, `eventName`?): `undefined` \| `number`
-
-Publishes a message to the SSE channel.
-
-#### Parameters
-
-• **data?**: `string` \| `Record`\<`string`, `any`\>
-
-The data to send. It can be a string or an object.
-
-• **eventName?**: `string`
-
-The name of the event.
-
-#### Returns
-
-`undefined` \| `number`
-
-- Returns the ID of the message.
-
-#### Throws
-
-Will throw an error if the channel is closed.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:93](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L93)
-
-***
-
-### subscribe()
-
-> **subscribe**(`req`, `res`, `events`?): `object`
-
-Subscribes a client to the SSE channel.
-
-#### Parameters
-
-• **req**: `IncomingMessage`
-
-The request object.
-
-• **res**: `ServerResponse`\<`IncomingMessage`\>
-
-The response object.
-
-• **events?**: `Events`
-
-The events to subscribe to.
-
-#### Returns
-
-`object`
-
-- Returns the client object.
-
-##### events
-
-> **events**: `undefined` \| `Events`
-
-##### req
-
-> **req**: `IncomingMessage`
-
-##### res
-
-> **res**: `ServerResponse`\<`IncomingMessage`\>
-
-#### Throws
-
-Will throw an error if the channel is closed.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:143](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L143)
-
-***
-
-### unsubscribe()
-
-> **unsubscribe**(`c`): `void`
-
-Unsubscribes a client from the SSE channel.
-
-#### Parameters
-
-• **c**: `Client`
-
-The client to unsubscribe.
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:190](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/sse-channel.ts#L190)

package/docs/classes/Semaphore.md

@@ -1,177 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / Semaphore
-
-# Class: Semaphore
-
-A Semaphore implementation for managing concurrency in asynchronous operations.
-Semaphores allow a fixed number of resources to be accessed concurrently.
-
-Example usage:
-
-```typescript
-const semaphore = new Semaphore(5); // Allows 5 concurrent operations.
-
-const semaphore = new Semaphore(
-  4, // Allow 4 concurrent async calls
-  {
-    capacity: 100 // Prealloc space for 100 tokens
-  }
-);
-
-async function fetchData(x) {
-  await semaphore.acquire()
-  try {
-    console.log(semaphore.pendingCount() + ' calls to fetch are waiting')
-    // ... do some async stuff with x
-  } finally {
-    semaphore.release();
-  }
-}
-
-const data = await Promise.all(array.map(fetchData));
-```
-
-## Constructors
-
-### new Semaphore()
-
-> **new Semaphore**(`maxConcurrency`, `__namedParameters`): [`Semaphore`](Semaphore.md)
-
-Creates a semaphore object. The first argument is the maximum concurrently number and the second argument is optional.
-
-#### Parameters
-
-• **maxConcurrency**: `number`
-
-The maximum number of callers allowed to acquire the semaphore concurrently.
-
-• **\_\_namedParameters** = `{}`
-
-• **\_\_namedParameters.capacity?**: `number` = `DefaultAsyncSemaphoreCapacity`
-
-• **\_\_namedParameters.initFn?** = `defaultInit`
-
-• **\_\_namedParameters.pauseFn?**
-
-• **\_\_namedParameters.resumeFn?**
-
-#### Returns
-
-[`Semaphore`](Semaphore.md)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:207](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L207)
-
-## Properties
-
-### maxConcurrency
-
-> `readonly` **maxConcurrency**: `number`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:151](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L151)
-
-***
-
-### waiting
-
-> `readonly` **waiting**: `Deque`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:152](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L152)
-
-## Methods
-
-### acquire()
-
-> **acquire**(`signal`?): `Promise`\<`any`\>
-
-Acquire a token from the semaphore, thus decrement the number of available execution slots. If initFn is not used then the return value of the function can be discarded.
-
-#### Parameters
-
-• **signal?**: `AbortSignal`
-
-#### Returns
-
-`Promise`\<`any`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:265](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L265)
-
-***
-
-### drain()
-
-> **drain**(): `Promise`\<`any`[]\>
-
-Drains the semaphore and returns all the initialized tokens in an array. Draining is an ideal way to ensure there are no pending async tasks, for example before a process will terminate.
-
-#### Returns
-
-`Promise`\<`any`[]\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:301](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L301)
-
-***
-
-### pendingCount()
-
-> **pendingCount**(): `number`
-
-Returns the number of callers waiting on the semaphore, i.e. the number of pending promises.
-
-#### Returns
-
-`number`
-
-The number of waiters in the waiting list.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:314](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L314)
-
-***
-
-### release()
-
-> **release**(`token`?): `void`
-
-Release the semaphore, thus increment the number of free execution slots. If initFn is used then the token returned by acquire() should be given as an argument when calling this function.
-
-#### Parameters
-
-• **token?**: `any`
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:294](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L294)
-
-***
-
-### tryAcquire()
-
-> **tryAcquire**(): `any`
-
-Attempt to acquire a token from the semaphore, if one is available immediately. Otherwise, return undefined.
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/async-semaphore.ts:258](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/async-semaphore.ts#L258)