@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/classes/SSEChannel.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Class: SSEChannel
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L25)
+
 A class for creating Server-Sent Events (SSE) channels.
 
 ## Example
@@ -21,11 +23,15 @@ sseChannel.publish('Hello, world!', 'greeting')
 
 > **new SSEChannel**(`options`?): [`SSEChannel`](SSEChannel.md)
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:65](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L65)
+
 Creates a new SSE channel.
 
 #### Parameters
 
-• **options?**: `Record`\<`string`, `any`\>
+##### options?
+
+`Record`\<`string`, `any`\>
 
 The options for the SSE channel.
 
@@ -33,19 +39,13 @@ The options for the SSE channel.
 
 [`SSEChannel`](SSEChannel.md)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:65](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L26)
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:26](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L26)
 
 ***
 
@@ -53,9 +53,7 @@ The options for the SSE channel.
 
 > **clients**: `Set`\<`Client`\>
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:27](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L27)
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:27](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L27)
 
 ***
 
@@ -63,9 +61,7 @@ The options for the SSE channel.
 
 > **messages**: `Record`\<`string`, `any`\>[]
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:28](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L28)
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:28](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L28)
 
 ***
 
@@ -73,9 +69,7 @@ The options for the SSE channel.
 
 > **nextID**: `number`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:29](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L29)
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L29)
 
 ***
 
@@ -83,9 +77,7 @@ The options for the SSE channel.
 
 > **options**: `Record`\<`string`, `any`\>
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:30](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L30)
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:30](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L30)
 
 ***
 
@@ -93,29 +85,37 @@ The options for the SSE channel.
 
 > `optional` **pingTimer**: `Timeout`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:31](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L31)
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L31)
 
 ## Accessors
 
 ### active
 
-> `get` **active**(): `boolean`
+#### Get Signature
 
-> `set` **active**(`v`): `void`
+> **get** **active**(): `boolean`
 
-#### Parameters
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:33](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L33)
 
-• **v**: `boolean`
+##### Returns
 
-#### Returns
+`boolean`
+
+#### Set Signature
+
+> **set** **active**(`v`): `void`
+
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:37](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L37)
+
+##### Parameters
+
+###### v
 
 `boolean`
 
-#### Defined in
+##### Returns
 
-[packages/ai-tool/src/utils/event/sse-channel.ts:33](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L33)
+`void`
 
 ## Methods
 
@@ -123,20 +123,20 @@ The options for the SSE channel.
 
 > **clearClients**(): `void`
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:195](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L195)
+
 #### Returns
 
 `void`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/event/sse-channel.ts:195](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L195)
-
 ***
 
 ### getSubscriberCount()
 
 > **getSubscriberCount**(): `number`
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:220](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L220)
+
 Gets the number of clients subscribed to the SSE channel.
 
 #### Returns
@@ -145,16 +145,14 @@ Gets the number of clients subscribed to the SSE channel.
 
 - 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L220)
-
 ***
 
 ### listClients()
 
 > **listClients**(): `Record`\<`string`, `number`\>
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:204](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L204)
+
 Lists the clients connected to the SSE channel grouped by IP address.
 
 #### Returns
@@ -163,25 +161,27 @@ Lists the clients connected to the SSE channel grouped by IP address.
 
 - 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L204)
-
 ***
 
 ### publish()
 
 > **publish**(`data`?, `eventName`?): `undefined` \| `number`
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:93](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L93)
+
 Publishes a message to the SSE channel.
 
 #### Parameters
 
-• **data?**: `string` \| `Record`\<`string`, `any`\>
+##### data?
 
 The data to send. It can be a string or an object.
 
-• **eventName?**: `string`
+`string` | `Record`\<`string`, `any`\>
+
+##### eventName?
+
+`string`
 
 The name of the event.
 
@@ -195,29 +195,33 @@ The name of the event.
 
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L93)
-
 ***
 
 ### subscribe()
 
 > **subscribe**(`req`, `res`, `events`?): `object`
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:143](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L143)
+
 Subscribes a client to the SSE channel.
 
 #### Parameters
 
-• **req**: `IncomingMessage`
+##### req
+
+`IncomingMessage`
 
 The request object.
 
-• **res**: `ServerResponse`\<`IncomingMessage`\>
+##### res
+
+`ServerResponse`
 
 The response object.
 
-• **events?**: `Events`
+##### events?
+
+`Events`
 
 The events to subscribe to.
 
@@ -243,28 +247,24 @@ The events to subscribe to.
 
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L143)
-
 ***
 
 ### unsubscribe()
 
 > **unsubscribe**(`c`): `void`
 
+Defined in: [packages/ai-tool/src/utils/event/sse-channel.ts:190](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/event/sse-channel.ts#L190)
+
 Unsubscribes a client from the SSE channel.
 
 #### Parameters
 
-• **c**: `Client`
+##### 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/event/sse-channel.ts#L190)