npm - @isdk/ai-tool - Versions diffs - 0.5.8 → 0.7.0 - Mend

@isdk/ai-tool 0.5.8 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (497) hide show

package/docs/{functions → api/functions}/shutdown.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **shutdown**(`signalOrEvent`, `exitCode`): `Promise`\<`undefined`\>
-Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:64](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/node/before-shutdown.ts#L64)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/node/before-shutdown.ts:64](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/node/before-shutdown.ts#L64)
 Main process shutdown handler. Will invoke every previously registered async shutdown listener
 in the queue and exit with a code of `0`. Any `Promise` rejections from any listener will

package/docs/{functions → api/functions}/simplifyObjectArguments.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **simplifyObjectArguments**(`args`): `any`
-Defined in: [packages/ai-tool/src/utils/parse-command.ts:121](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L121)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:121](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/parse-command.ts#L121)
 ## Parameters

package/docs/api/functions/sleep.md ADDED Viewed

@@ -0,0 +1,36 @@
+[**@isdk/ai-tool**](../README.md)
+***
+[@isdk/ai-tool](../globals.md) / sleep
+# Function: sleep()
+> **sleep**(`ms`): `Promise`\<`void`\>
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/wait.ts:12](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/wait.ts#L12)
+Suspends execution for a specified number of milliseconds
+## Parameters
+### ms
+`number`
+The number of milliseconds to pause execution
+## Returns
+`Promise`\<`void`\>
+## Example
+```ts
+await sleep(500); // Pause for half a second
+```
+## Remarks
+This implementation uses `setTimeout` under the hood and is more precise
+for longer durations than `setImmediate`-based approaches

package/docs/{functions → api/functions}/sortedValues.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **sortedValues**\<`T`\>(`values`): `T`[]
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:4](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L4)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:4](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L4)
 ## Type Parameters

package/docs/{functions → api/functions}/splitChunks.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **splitChunks**(`content`, `options`?): `Promise`\<`string`[][]\>
-Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:182](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/read-text-file-chunks.ts#L182)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/read-text-file-chunks.ts:182](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/read-text-file-chunks.ts#L182)
 ## Parameters

package/docs/{functions → api/functions}/splitParagraph.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **splitParagraph**(`value`, `options`?): `string`[][]
-Defined in: [packages/ai-tool/src/utils/split-paragraph.ts:12](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-paragraph.ts#L12)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-paragraph.ts:12](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/split-paragraph.ts#L12)
 Splits the input string into paragraphs based on empty lines and title lines.
 Each paragraph is represented as an array of strings, where each string is a line in the paragraph.

package/docs/{functions → api/functions}/splitSentence.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **splitSentence**(`text`, `best`): `string`[]
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:44](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L44)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:44](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/split-sentence.ts#L44)
 Splits a text into sentences.
 This function is used to split a text into separate sentences, based on punctuation marks such as '.', '?', or '!' and other rules.

package/docs/api/functions/splitWords.md ADDED Viewed

@@ -0,0 +1,42 @@
+[**@isdk/ai-tool**](../README.md)
+***
+[@isdk/ai-tool](../globals.md) / splitWords
+# Function: splitWords()
+> **splitWords**(`input`): `string`[]
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-words.ts:41](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/split-words.ts#L41)
+Splits a string into an array of words based on case changes, digit boundaries, and spaces.
+This function identifies word boundaries using the following rules:
+1. Between a lowercase letter followed by an uppercase letter (camelCase)
+2. Between a digit and a letter (alphanumeric boundaries)
+3. Between consecutive uppercase letters when followed by a lowercase letter (acronyms)
+4. At whitespace characters
+## Parameters
+### input
+`string`
+The string to be split into words
+## Returns
+`string`[]
+An array of words extracted from the input string
+## Example
+```ts
+splitWords("HelloWorld")     // Returns ["Hello", "World"]
+splitWords("item1label21Good") // Returns ["item1", "label21", "Good"]
+splitWords("HTTPRequest")    // Returns ["HTTP", "Request"]
+splitWords("Good morning")   // Returns ["Good", "morning"]
+```

package/docs/api/functions/stringifyYaml.md ADDED Viewed

@@ -0,0 +1,45 @@
+[**@isdk/ai-tool**](../README.md)
+***
+[@isdk/ai-tool](../globals.md) / stringifyYaml
+# Function: stringifyYaml()
+> **stringifyYaml**(`content`, `options`?): `string`
+Defined in: @isdk/util/dist/index.d.ts:317
+Converts a JavaScript object into a YAML string with optional custom tags.
+## Parameters
+### content
+`any`
+The JavaScript object to convert to YAML.
+### options?
+`DocumentOptions` & `SchemaOptions` & `ParseOptions` & `CreateNodeOptions` & `ToStringOptions`
+Optional stringification options, including custom tags.
+## Returns
+`string`
+The YAML string representation of the input object.
+## Example
+```typescript
+import { stringifyYaml } from './yaml';
+const data = {
+  example: 'value',
+};
+const yamlString = stringifyYaml(data);
+console.log(yamlString); // "example: value\n"
+```

package/docs/{functions → api/functions}/stripConsoleColor.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **stripConsoleColor**(`str`): `any`
-Defined in: [packages/ai-tool/src/utils/strip-console-color.ts:1](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/strip-console-color.ts#L1)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/strip-console-color.ts:1](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/strip-console-color.ts#L1)
 ## Parameters

package/docs/{functions → api/functions}/textToDate.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **textToDate**(`date`, `format`): `Date`
-Defined in: [packages/ai-tool/src/utils/to-datetime.ts:25](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/to-datetime.ts#L25)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/to-datetime.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/to-datetime.ts#L31)
 ## Parameters

package/docs/{functions → api/functions}/throwError.md RENAMED Viewed

@@ -6,9 +6,9 @@
 # Function: throwError()
-> **throwError**(`message`, `name`?, `status`?): `void`
+> **throwError**(`message`, `name`?, `status`?): `never`
-Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:161
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/@isdk+common-error@0.2.0/node\_modules/@isdk/common-error/dist/index.d.ts:172
 Throw an error
@@ -34,7 +34,7 @@ Error status code, default to 500
 ## Returns
-`void`
+`never`
 ## Throws

package/docs/{functions → api/functions}/toDate.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **toDate**\<`DateType`, `ResultDate`\>(`argument`, `context`?): `ResultDate`
-Defined in: node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/toDate.d.ts:40
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/toDate.d.ts:40
 ## Type Parameters

package/docs/{functions → api/functions}/toDateTime.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **toDateTime**(`date`): `undefined` \| `Date`
-Defined in: [packages/ai-tool/src/utils/to-datetime.ts:9](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/to-datetime.ts#L9)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/to-datetime.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/to-datetime.ts#L15)
 ## Parameters

package/docs/{functions → api/functions}/toRegExp.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **toRegExp**(`value`): `RegExp`
-Defined in: node\_modules/.pnpm/util-ex@2.2.1/node\_modules/util-ex/lib/to-regexp.d.ts:9
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/util-ex@2.3.0/node\_modules/util-ex/lib/to-regexp.d.ts:9
 create or clone RegExp

package/docs/{functions → api/functions}/trimStartOfStreamHelper.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **trimStartOfStreamHelper**(): (`text`) => `string`
-Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:90](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/stream/ai-stream.ts#L90)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:90](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/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

package/docs/{functions → api/functions}/truncTo.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **truncTo**(`n`, `dec`, `up`): `number`
-Defined in: [packages/ai-tool/src/utils/trunc-to.ts:19](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/trunc-to.ts#L19)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/trunc-to.ts:19](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/trunc-to.ts#L19)
 Truncates(Round) a number to a specified number of decimal places.

package/docs/{functions → api/functions}/truncateByToken.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/truncate-to-token-limit.ts#L164)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/truncate-to-token-limit.ts:164](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/truncate-to-token-limit.ts#L164)
 ## Parameters

package/docs/{functions → api/functions}/truncateToTokenLimit.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/truncate-to-token-limit.ts#L31)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/truncate-to-token-limit.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/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.

package/docs/{functions → api/functions}/truncateToTokenLimitEx.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/truncate-to-token-limit.ts#L111)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/truncate-to-token-limit.ts:111](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/truncate-to-token-limit.ts#L111)
 ## Parameters

package/docs/{functions → api/functions}/uuid.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **uuid**(`ver`, `encode`?): `string`
-Defined in: [packages/ai-tool/src/utils/hash/uuid.ts:8](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/hash/uuid.ts#L8)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/uuid.ts:8](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/uuid.ts#L8)
 ## Parameters

package/docs/{functions → api/functions}/uuidParse.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **uuidParse**(`uuid`): `Uint8Array`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/parse.d.ts:1
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/parse.d.ts:1
 ## Parameters

package/docs/{functions → api/functions}/uuidStringify.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **uuidStringify**(`arr`, `offset`?): `string`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/stringify.d.ts:2
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/stringify.d.ts:2
 ## Parameters

package/docs/{functions → api/functions}/uuidValidate.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **uuidValidate**(`uuid`): `boolean`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/validate.d.ts:1
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/validate.d.ts:1
 ## Parameters

package/docs/{functions → api/functions}/uuidVersion.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **uuidVersion**(`uuid`): `number`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/version.d.ts:1
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/version.d.ts:1
 ## Parameters

package/docs/{functions → api/functions}/uuidv1.md RENAMED Viewed

@@ -10,7 +10,7 @@
 > **uuidv1**(`options`?, `buf`?, `offset`?): `string`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v1.d.ts:8
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/v1.d.ts:8
 ### Parameters
@@ -32,9 +32,13 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 ## Call Signature
-> **uuidv1**(`options`, `buf`, `offset`?): `Uint8Array`
+> **uuidv1**\<`Buf`\>(`options`, `buf`, `offset`?): `Buf`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v1.d.ts:9
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/v1.d.ts:9
+### Type Parameters
+• **Buf** *extends* `Uint8Array`\<`ArrayBufferLike`\> = `Uint8Array`\<`ArrayBufferLike`\>
 ### Parameters
@@ -44,7 +48,7 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 #### buf
-`Uint8Array`
+`Buf`
 #### offset?
@@ -52,4 +56,4 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 ### Returns
-`Uint8Array`
+`Buf`

package/docs/{functions → api/functions}/uuidv4.md RENAMED Viewed

@@ -10,7 +10,7 @@
 > **uuidv4**(`options`?, `buf`?, `offset`?): `string`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v4.d.ts:2
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/v4.d.ts:2
 ### Parameters
@@ -32,9 +32,13 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 ## Call Signature
-> **uuidv4**(`options`, `buf`, `offset`?): `Uint8Array`
+> **uuidv4**\<`TBuf`\>(`options`, `buf`, `offset`?): `TBuf`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v4.d.ts:3
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/v4.d.ts:3
+### Type Parameters
+• **TBuf** *extends* `Uint8Array`\<`ArrayBufferLike`\> = `Uint8Array`\<`ArrayBufferLike`\>
 ### Parameters
@@ -44,7 +48,7 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 #### buf
-`Uint8Array`
+`TBuf`
 #### offset?
@@ -52,4 +56,4 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 ### Returns
-`Uint8Array`
+`TBuf`

package/docs/{functions → api/functions}/uuidv5.md RENAMED Viewed

@@ -10,7 +10,7 @@
 > **uuidv5**(`value`, `namespace`, `buf`?, `offset`?): `string`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v5.d.ts:3
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/v5.d.ts:3
 ### Parameters
@@ -36,9 +36,13 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 ## Call Signature
-> **uuidv5**(`value`, `namespace`, `buf`, `offset`?): `Uint8Array`
+> **uuidv5**\<`TBuf`\>(`value`, `namespace`, `buf`, `offset`?): `TBuf`
-Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/v5.d.ts:4
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/uuid@11.1.0/node\_modules/uuid/dist/esm-browser/v5.d.ts:4
+### Type Parameters
+• **TBuf** *extends* `Uint8Array`\<`ArrayBufferLike`\> = `Uint8Array`\<`ArrayBufferLike`\>
 ### Parameters
@@ -52,7 +56,7 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 #### buf
-`Uint8Array`
+`TBuf`
 #### offset?
@@ -60,4 +64,4 @@ Defined in: node\_modules/.pnpm/uuid@11.0.3/node\_modules/uuid/dist/esm-browser/
 ### Returns
-`Uint8Array`
+`TBuf`

package/docs/api/functions/wait.md ADDED Viewed

@@ -0,0 +1,45 @@
+[**@isdk/ai-tool**](../README.md)
+***
+[@isdk/ai-tool](../globals.md) / wait
+# Function: ~~wait()~~
+> **wait**(`ms`): `Promise`\<`void`\>
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/wait.ts:23](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/wait.ts#L23)
+## Parameters
+### ms
+`number`
+The number of milliseconds to pause execution
+## Returns
+`Promise`\<`void`\>
+## Alias
+sleep
+## Deprecated
+Use [sleep](sleep.md) for clearer intent
+Legacy alias maintained for backward compatibility.
+Prefer the more explicit `sleep` naming in new code.
+## Example
+```ts
+await sleep(500); // Pause for half a second
+```
+## Remarks
+This implementation uses `setTimeout` under the hood and is more precise
+for longer durations than `setImmediate`-based approaches

package/docs/{functions → api/functions}/wrapEventEmitter.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **wrapEventEmitter**(`o`?): `any`
-Defined in: node\_modules/.pnpm/events-ex@2.0.1/node\_modules/events-ex/lib/wrap-event-emitter.d.ts:6
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/events-ex@2.1.0/node\_modules/events-ex/lib/wrap-event-emitter.d.ts:6
 Create or inject the eventable instance into the object

package/docs/{functions → api/functions}/xxhash.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **xxhash**(`value`, `hashAlgo`, `seed`): `Uint8Array`
-Defined in: [packages/ai-tool/src/utils/hash/xxhash.ts:24](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/hash/xxhash.ts#L24)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/xxhash.ts:24](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/xxhash.ts#L24)
 ## Parameters

package/docs/{functions → api/functions}/xxhash32.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **xxhash32**(`value`, `radix`): `string`
-Defined in: [packages/ai-tool/src/utils/hash/xxhash.ts:8](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/hash/xxhash.ts#L8)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/xxhash.ts:8](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/xxhash.ts#L8)
 ## Parameters

package/docs/{functions → api/functions}/xxhash64.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **xxhash64**(`value`, `radix`): `string`
-Defined in: [packages/ai-tool/src/utils/hash/xxhash.ts:15](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/hash/xxhash.ts#L15)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/xxhash.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/xxhash.ts#L15)
 ## Parameters

package/docs/{functions → api/functions}/xxhashAsStr.md RENAMED Viewed

@@ -8,7 +8,7 @@
 > **xxhashAsStr**(`value`, `hashAlgo`, `seed`): `string`
-Defined in: [packages/ai-tool/src/utils/hash/xxhash.ts:40](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/hash/xxhash.ts#L40)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/hash/xxhash.ts:40](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/hash/xxhash.ts#L40)
 ## Parameters

package/docs/api/functions/yieldExec.md ADDED Viewed

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md)
+***
+[@isdk/ai-tool](../globals.md) / yieldExec
+# Function: yieldExec()
+> **yieldExec**(): `Promise`\<`void`\>
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/wait.ts:37](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/wait.ts#L37)
+Yields execution control to the event loop, allowing pending I/O operations
+and scheduled tasks to run before continuing.
+## Returns
+`Promise`\<`void`\>
+## Remarks
+This method creates a microtask checkpoint using `setImmediate`, which helps:
+- Interleave CPU-intensive work with I/O events
+- Prevent event loop blocking
+- Maintain application responsiveness
+Particularly useful for breaking up long synchronous operations in Node.js.