@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/functions/toRegExp.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,18 @@
 
 > **toRegExp**(`value`): `RegExp`
 
+Defined in: node\_modules/.pnpm/util-ex@2.2.1/node\_modules/util-ex/lib/to-regexp.d.ts:9
+
 create or clone RegExp
 
 ## Parameters
 
-• **value**: `string` \| `RegExp`
+### value
 
 create a new RegExp from.
 
+`string` | `RegExp`
+
 ## Returns
 
 `RegExp`
@@ -28,7 +32,3 @@ create a new RegExp from.
 toRegExp('/[a-z]/g') // new RegExp(/[a-z]/g)
 toRegExp(/[a-z]/g)  // new RegExp(/[a-z]/g)
 ```
-
-## Defined in
-
-node\_modules/.pnpm/util-ex@2.0.0/node\_modules/util-ex/lib/to-regexp.d.ts:9

package/docs/functions/trimStartOfStreamHelper.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,6 +8,8 @@
 
 > **trimStartOfStreamHelper**(): (`text`) => `string`
 
+Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:90](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/ai-stream.ts#L90)
+
 Returns a stateful function that, when invoked, trims leading whitespace
 from the input text. The trimming only occurs on the first invocation, ensuring that
 subsequent calls do not alter the input text. This is particularly useful in scenarios
@@ -22,7 +24,9 @@ with leading whitespace removed if it is the first invocation; otherwise, it ret
 
 ### Parameters
 
-• **text**: `string`
+#### text
+
+`string`
 
 ### Returns
 
@@ -35,7 +39,3 @@ const trimStart = trimStartOfStreamHelper();
 const output1 = trimStart("   text"); // "text"
 const output2 = trimStart("   text"); // "   text"
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/ai-stream.ts:92](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/stream/ai-stream.ts#L92)

package/docs/functions/truncTo.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,19 +8,27 @@
 
 > **truncTo**(`n`, `dec`, `up`): `number`
 
+Defined in: [packages/ai-tool/src/utils/trunc-to.ts:19](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/trunc-to.ts#L19)
+
 Truncates(Round) a number to a specified number of decimal places.
 
 ## Parameters
 
-• **n**: `number`
+### n
+
+`number`
 
 The number to truncate.
 
-• **dec**: `number` = `2`
+### dec
+
+`number` = `2`
 
 The number of decimal places to truncate to (default is 2).
 
-• **up**: `number` = `0.5`
+### up
+
+`number` = `0.5`
 
 The amount to round up by before truncating (default is 0.5).
 
@@ -41,7 +49,3 @@ truncTo(1.2345, 3)
 // returns 1.24
 truncTo(1.2345, 2, 0.6)
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/trunc-to.ts:19](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/trunc-to.ts#L19)

package/docs/functions/truncateByToken.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **truncateByToken**(`content`, `options`?): `Promise`\<`void`\>
 
+Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:164](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/truncate-to-token-limit.ts#L164)
+
 ## Parameters
 
-• **content**: `string`
+### content
 
-• **options?**: [`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
+`string`
 
-## Returns
+### options?
 
-`Promise`\<`void`\>
+[`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:164](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/truncate-to-token-limit.ts#L164)
+`Promise`\<`void`\>

package/docs/functions/truncateToTokenLimit.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,22 @@
 
 > **truncateToTokenLimit**(`content`, `options`?): `Promise`\<`string`\>
 
+Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/truncate-to-token-limit.ts#L31)
+
 Truncates the given content to fit within a specified token limit by removing sentences from the end.
 This function is suitable for text content with multiple sentences.
 
 ## Parameters
 
-• **content**: `string`
+### content
+
+`string`
 
 The original text content to be processed.
 
-• **options?**: [`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
+### options?
+
+[`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
 
 Optional configuration including model ID and size limit.
 
@@ -38,7 +44,3 @@ console.log(truncatedText); // Output may be the truncated text
 ## Warning
 
 This function is designed for text content with multiple sentences.
-
-## Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:31](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/truncate-to-token-limit.ts#L31)

package/docs/functions/truncateToTokenLimitEx.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **truncateToTokenLimitEx**(`sentences`, `options`?): `Promise`\<`string`[]\>
 
+Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:111](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/truncate-to-token-limit.ts#L111)
+
 ## Parameters
 
-• **sentences**: `string`[]
+### sentences
 
-• **options?**: [`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
+`string`[]
 
-## Returns
+### options?
 
-`Promise`\<`string`[]\>
+[`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:111](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/truncate-to-token-limit.ts#L111)
+`Promise`\<`string`[]\>

package/docs/functions/uuid.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **uuid**(`ver`, `encode`?): `string`
 
+Defined in: [packages/ai-tool/src/utils/hash/uuid.ts:8](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/hash/uuid.ts#L8)
+
 ## Parameters
 
-• **ver**: `1` \| `4` \| `5` = `1`
+### ver
 
-• **encode?**: `boolean`
+`1` | `4` | `5`
 
-## Returns
+### encode?
 
-`string`
+`boolean`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/hash/uuid.ts:8](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/hash/uuid.ts#L8)
+`string`

package/docs/functions/uuidParse.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **uuidParse**(`uuid`): `Uint8Array`
 
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/parse.d.ts:1
+
 ## Parameters
 
-• **uuid**: `string`
+### uuid
+
+`string`
 
 ## Returns
 
 `Uint8Array`
-
-## Defined in
-
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:102

package/docs/functions/uuidStringify.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,18 +6,20 @@
 
 # Function: uuidStringify()
 
-> **uuidStringify**(`buffer`, `offset`?): `string`
+> **uuidStringify**(`arr`, `offset`?): `string`
+
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/stringify.d.ts:2
 
 ## Parameters
 
-• **buffer**: `InputBuffer`
+### arr
 
-• **offset?**: `number`
+`Uint8Array`
 
-## Returns
+### offset?
 
-`string`
+`number`
 
-## Defined in
+## Returns
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:103
+`string`

package/docs/functions/uuidValidate.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **uuidValidate**(`uuid`): `boolean`
 
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/validate.d.ts:1
+
 ## Parameters
 
-• **uuid**: `string`
+### uuid
+
+`unknown`
 
 ## Returns
 
 `boolean`
-
-## Defined in
-
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:112

package/docs/functions/uuidVersion.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **uuidVersion**(`uuid`): `number`
 
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/version.d.ts:1
+
 ## Parameters
 
-• **uuid**: `string`
+### uuid
+
+`string`
 
 ## Returns
 
 `number`
-
-## Defined in
-
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:113

package/docs/functions/uuidv1.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,42 +6,50 @@
 
 # Function: uuidv1()
 
-## uuidv1(options, buffer, offset)
+## Call Signature
 
-> **uuidv1**\<`T`\>(`options`, `buffer`, `offset`?): `T`
+> **uuidv1**(`options`?, `buf`?, `offset`?): `string`
 
-### Type Parameters
-
-• **T** *extends* `OutputBuffer`
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v1.d.ts:8
 
 ### Parameters
 
-• **options**: `undefined` \| `null` \| `V1Options`
+#### options?
 
-• **buffer**: `T`
+`Version1Options`
 
-• **offset?**: `number`
+#### buf?
 
-### Returns
+`undefined`
+
+#### offset?
 
-`T`
+`number`
 
-### Defined in
+### Returns
+
+`string`
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:104
+## Call Signature
 
-## uuidv1(options)
+> **uuidv1**(`options`, `buf`, `offset`?): `Uint8Array`
 
-> **uuidv1**(`options`?): `string`
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v1.d.ts:9
 
 ### Parameters
 
-• **options?**: `V1Options`
+#### options
 
-### Returns
+`undefined` | `Version1Options`
 
-`string`
+#### buf
+
+`Uint8Array`
 
-### Defined in
+#### offset?
+
+`number`
+
+### Returns
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:104
+`Uint8Array`

package/docs/functions/uuidv4.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,42 +6,50 @@
 
 # Function: uuidv4()
 
-## uuidv4(options, buffer, offset)
+## Call Signature
 
-> **uuidv4**\<`T`\>(`options`, `buffer`, `offset`?): `T`
+> **uuidv4**(`options`?, `buf`?, `offset`?): `string`
 
-### Type Parameters
-
-• **T** *extends* `OutputBuffer`
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v4.d.ts:2
 
 ### Parameters
 
-• **options**: `undefined` \| `null` \| `V4Options`
+#### options?
 
-• **buffer**: `T`
+`Version4Options`
 
-• **offset?**: `number`
+#### buf?
 
-### Returns
+`undefined`
+
+#### offset?
 
-`T`
+`number`
 
-### Defined in
+### Returns
+
+`string`
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:107
+## Call Signature
 
-## uuidv4(options)
+> **uuidv4**(`options`, `buf`, `offset`?): `Uint8Array`
 
-> **uuidv4**(`options`?): `string`
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v4.d.ts:3
 
 ### Parameters
 
-• **options?**: `V4Options`
+#### options
 
-### Returns
+`undefined` | `Version4Options`
 
-`string`
+#### buf
+
+`Uint8Array`
 
-### Defined in
+#### offset?
+
+`number`
+
+### Returns
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:107
+`Uint8Array`

package/docs/functions/uuidv5.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,46 +6,58 @@
 
 # Function: uuidv5()
 
-## uuidv5(name, namespace, buffer, offset)
+## Call Signature
 
-> **uuidv5**\<`T`\>(`name`, `namespace`, `buffer`, `offset`?): `T`
+> **uuidv5**(`value`, `namespace`, `buf`?, `offset`?): `string`
 
-### Type Parameters
-
-• **T** *extends* `OutputBuffer`
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v5.d.ts:3
 
 ### Parameters
 
-• **name**: `string` \| `InputBuffer`
+#### value
 
-• **namespace**: `string` \| `InputBuffer`
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
 
-• **buffer**: `T`
+#### namespace
 
-• **offset?**: `number`
+`UUIDTypes`
 
-### Returns
+#### buf?
+
+`undefined`
+
+#### offset?
 
-`T`
+`number`
 
-### Defined in
+### Returns
+
+`string`
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:108
+## Call Signature
 
-## uuidv5(name, namespace)
+> **uuidv5**(`value`, `namespace`, `buf`, `offset`?): `Uint8Array`
 
-> **uuidv5**(`name`, `namespace`): `string`
+Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v5.d.ts:4
 
 ### Parameters
 
-• **name**: `string` \| `InputBuffer`
+#### value
 
-• **namespace**: `string` \| `InputBuffer`
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
 
-### Returns
+#### namespace
 
-`string`
+`UUIDTypes`
+
+#### buf
+
+`Uint8Array`
 
-### Defined in
+#### offset?
+
+`number`
+
+### Returns
 
-node\_modules/.pnpm/@types+uuid@10.0.0/node\_modules/@types/uuid/index.d.ts:108
+`Uint8Array`

package/docs/functions/wait.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **wait**(`ms`): `Promise`\<`void`\>
 
+Defined in: [packages/ai-tool/src/utils/wait.ts:1](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/wait.ts#L1)
+
 ## Parameters
 
-• **ms**: `number`
+### ms
+
+`number`
 
 ## Returns
 
 `Promise`\<`void`\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/wait.ts:1](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/wait.ts#L1)

package/docs/functions/wrapEventEmitter.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / wrapEventEmitter
+
+# Function: wrapEventEmitter()
+
+> **wrapEventEmitter**(`o`?): `any`
+
+Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/wrap-event-emitter.d.ts:6
+
+Create or inject the eventable instance into the object
+
+## Parameters
+
+### o?
+
+`any`
+
+the optional instance to eventable
+
+## Returns
+
+`any`
+
+o or new Event instance