@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/functions/replaceWithPlaceholder.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,17 +6,23 @@
 
 # Function: replaceWithPlaceholder()
 
-> **replaceWithPlaceholder**(`content`, `options`?): [`string`, `string`[]]
+> **replaceWithPlaceholder**(`content`, `options`?): \[`string`, `string`[]\]
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:487](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/parse-command.ts#L487)
 
 Replaces substrings in the given content with placeholders.
 
 ## Parameters
 
-• **content**: `string`
+### content
+
+`string`
 
 The string content to process.
 
-• **options?**: [`ReplacePlacehoderOptions`](../interfaces/ReplacePlacehoderOptions.md)
+### options?
+
+[`ReplacePlacehoderOptions`](../interfaces/ReplacePlacehoderOptions.md)
 
 Optional configuration object with the following properties:
   - `startChar` - The starting character(s) of the substrings to replace. Can be a single character or an array of characters. Defaults to `["\"", "'"]`.
@@ -26,7 +32,7 @@ Optional configuration object with the following properties:
 
 ## Returns
 
-[`string`, `string`[]]
+\[`string`, `string`[]\]
 
 An array containing:
   - `content` - The modified content with placeholders.
@@ -35,7 +41,3 @@ An array containing:
 ## Throws
 
 If the lengths of `startChar` and `endChar` are not the same.
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:438](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/parse-command.ts#L438)

package/docs/functions/restoreFromPlacehoders.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,19 +8,27 @@
 
 > **restoreFromPlacehoders**(`content`, `placehoders`, `options`?): `string`
 
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:540](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/parse-command.ts#L540)
+
 Restores the original substrings from placeholders in the given content.
 
 ## Parameters
 
-• **content**: `string`
+### content
+
+`string`
 
 The string content containing placeholders to be restored.
 
-• **placehoders**: `string`[]
+### placehoders
+
+`string`[]
 
 An array of the original substrings that were replaced by placeholders.
 
-• **options?**: [`ReplacePlacehoderOptions`](../interfaces/ReplacePlacehoderOptions.md)
+### options?
+
+[`ReplacePlacehoderOptions`](../interfaces/ReplacePlacehoderOptions.md)
 
 Optional configuration object with the following properties:
   - `placeholder` - The prefix for the placeholder names. Defaults to `__PlacEhoLdeR_`.
@@ -39,7 +47,3 @@ const originalSubstrings = ["World", "the site"];
 const restoredContent = restoreFromPlacehoders(contentWithPlaceholders, originalSubstrings);
 console.log(restoredContent); // Output: "Hello World, welcome to the site!"
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:491](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/parse-command.ts#L491)

package/docs/functions/sanitizeFilename.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,15 +8,21 @@
 
 > **sanitizeFilename**(`filename`, `options`): `string`
 
+Defined in: [packages/ai-tool/src/utils/filename.ts:97](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/filename.ts#L97)
+
 Sanitizes a given filename by replacing invalid characters with a specified replacement character or a default.
 
 ## Parameters
 
-• **filename**: `string`
+### filename
+
+`string`
 
 The filename to sanitize, represented as a string.
 
-• **options**: [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
+### options
+
+[`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
 
 An optional object containing configuration options:
   - `replacement` {string} - The character to replace invalid characters with. Default is '!'. Cannot contain reserved filename characters.
@@ -31,7 +37,3 @@ The sanitized filename.
 ## Throws
 
 - If the `replacement` contains reserved filename characters or control characters.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:97](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L97)

package/docs/functions/sanitizeFilepath.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,15 +8,21 @@
 
 > **sanitizeFilepath**(`filepath`, `options`): `string`
 
+Defined in: [packages/ai-tool/src/utils/filename.ts:149](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/filename.ts#L149)
+
 Sanitizes each part of a file path and reassembles it, ensuring the path is valid according to provided options.
 
 ## Parameters
 
-• **filepath**: `string`
+### filepath
+
+`string`
 
 The file path to sanitize, represented as a string.
 
-• **options**: [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
+### options
+
+[`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
 
 Optional settings for sanitization, extending `SanitizeFilenameOptions`. Allows customization of replacement characters and maximum filename length.
 
@@ -25,7 +31,3 @@ Optional settings for sanitization, extending `SanitizeFilenameOptions`. Allows
 `string`
 
 The sanitized file path as a string.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:149](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L149)

package/docs/functions/saveConfigFile.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,18 +8,22 @@
 
 > **saveConfigFile**(`filename`, `config`, `extLevel`): `string`
 
+Defined in: [packages/ai-tool/src/utils/config.ts:114](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/config.ts#L114)
+
 ## Parameters
 
-• **filename**: `string`
+### filename
 
-• **config**: `any`
+`string`
 
-• **extLevel**: `number` = `1`
+### config
 
-## Returns
+`any`
 
-`string`
+### extLevel
 
-## Defined in
+`number` = `1`
 
-[packages/ai-tool/src/utils/config.ts:88](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/config.ts#L88)
+## Returns
+
+`string`

package/docs/functions/scaleStrToParamsSize.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,11 +8,15 @@
 
 > **scaleStrToParamsSize**(`scale`): `number`
 
+Defined in: [packages/ai-tool/src/utils/convert-params-size.ts:44](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/convert-params-size.ts#L44)
+
 Converts a formatted parameters size string (with units T, B, M, or K) back to its byte value.
 
 ## Parameters
 
-• **scale**: `string`
+### scale
+
+`string`
 
 The formatted parameter size string (e.g., "1.23B", "456M", "789K", or "123").
 
@@ -21,7 +25,3 @@ The formatted parameter size string (e.g., "1.23B", "456M", "789K", or "123").
 `number`
 
 The parameter size in bytes.
-
-## Defined in
-
-[packages/ai-tool/src/utils/convert-params-size.ts:44](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/convert-params-size.ts#L44)

package/docs/functions/shutdown.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / shutdown
+
+# Function: shutdown()
+
+> **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/6a89194ac34437a1bc58f7ec590cd22976939ca6/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
+be logged out as a warning, but won't prevent other callbacks from executing.
+
+## Parameters
+
+### signalOrEvent
+
+The exit signal or event name received on the process, defaults to shutdown.
+
+`string` | `number`
+
+### exitCode
+
+The optional exit code, defaults to 0.
+
+`null` | `string` | `number`
+
+## Returns
+
+`Promise`\<`undefined`\>

package/docs/functions/simplifyObjectArguments.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **simplifyObjectArguments**(`args`): `any`
 
-## Parameters
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:121](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/parse-command.ts#L121)
 
-• **args**: `any`
+## Parameters
 
-## Returns
+### args
 
 `any`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/parse-command.ts:76](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/parse-command.ts#L76)
+`any`

package/docs/functions/sortedValues.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,18 +8,18 @@
 
 > **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/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L4)
+
 ## Type Parameters
 
 • **T**
 
 ## Parameters
 
-• **values**: `Record`\<`string`, `T`\>
+### values
+
+`Record`\<`string`, `T`\>
 
 ## Returns
 
 `T`[]
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:4](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L4)

package/docs/functions/splitChunks.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **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/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/read-text-file-chunks.ts#L182)
+
 ## Parameters
 
-• **content**: `string`
+### content
 
-• **options?**: [`IReadTextFileChunksOptions`](../interfaces/IReadTextFileChunksOptions.md)
+`string`
 
-## Returns
+### options?
 
-`Promise`\<`string`[][]\>
+[`IReadTextFileChunksOptions`](../interfaces/IReadTextFileChunksOptions.md)
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/read-text-file-chunks.ts:182](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/read-text-file-chunks.ts#L182)
+`Promise`\<`string`[][]\>

package/docs/functions/splitParagraph.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,22 @@
 
 > **splitParagraph**(`value`, `options`?): `string`[][]
 
+Defined in: [packages/ai-tool/src/utils/split-paragraph.ts:12](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/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.
 
 ## Parameters
 
-• **value**: `string`
+### value
+
+`string`
 
 The input string to be split into paragraphs.
 
-• **options?**: [`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md)
+### options?
+
+[`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md)
 
 Optional configuration options for splitting the string.
 
@@ -26,7 +32,3 @@ Optional configuration options for splitting the string.
 `string`[][]
 
 A two-dimensional array where each sub-array represents a paragraph.
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-paragraph.ts:12](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-paragraph.ts#L12)

package/docs/functions/splitSentence.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,22 @@
 
 > **splitSentence**(`text`, `best`): `string`[]
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:44](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/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.
 
 ## Parameters
 
-• **text**: `string`
+### text
+
+`string`
 
 The input string that needs to be split into sentences.
 
-• **best**: [`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md) = `{}`
+### best
+
+[`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md) = `{}`
 
 A boolean flag indicating if the function should use the best possible sentence splitting method (default is true).
 If set to false, it will not perform any additional processing and simply split on newline characters ('\n').
@@ -31,7 +37,3 @@ An array of strings where each string represents a sentence in the input text.
 Example:
 const text = "Hello world! How are you today? I am fine.";
 console.log(splitSentence(text));  // returns ['Hello world!', 'How are you today?', 'I am fine.']
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:44](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L44)

package/docs/functions/stringifyYaml.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,16 +6,20 @@
 
 # Function: stringifyYaml()
 
-> **stringifyYaml**(`content`): `string`
+> **stringifyYaml**(`content`, `options`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/config.ts:42](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/config.ts#L42)
 
 ## Parameters
 
-• **content**: `any`
+### content
 
-## Returns
+`any`
 
-`string`
+### options?
 
-## Defined in
+`DocumentOptions` & `SchemaOptions` & `ParseOptions` & `CreateNodeOptions` & `ToStringOptions`
 
-[packages/ai-tool/src/utils/config.ts:28](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/config.ts#L28)
+## Returns
+
+`string`

package/docs/functions/stripConsoleColor.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **stripConsoleColor**(`str`): `any`
 
-## Parameters
+Defined in: [packages/ai-tool/src/utils/strip-console-color.ts:1](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/strip-console-color.ts#L1)
 
-• **str**: `any`
+## Parameters
 
-## Returns
+### str
 
 `any`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/strip-console-color.ts:1](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/strip-console-color.ts#L1)
+`any`

package/docs/functions/textToDate.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **textToDate**(`date`, `format`): `Date`
 
+Defined in: [packages/ai-tool/src/utils/to-datetime.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/to-datetime.ts#L25)
+
 ## Parameters
 
-• **date**: `string`
+### date
 
-• **format**: `string` = `FormatDateStr`
+`string`
 
-## Returns
+### format
 
-`Date`
+`string` = `FormatDateStr`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/to-datetime.ts:25](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/to-datetime.ts#L25)
+`Date`

package/docs/functions/throwError.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,22 +8,30 @@
 
 > **throwError**(`message`, `name`?, `status`?): `void`
 
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:161
+
 Throw an error
 
 ## Parameters
 
-• **message**: `string`
+### message
+
+`string`
 
 Error message
 
-• **name?**: `string` \| `Record`\<`string`, `any`\>
+### name?
 
 Error name, optional
 
-• **status?**: `string` \| `number`
+`string` | `Record`\<`string`, `any`\>
+
+### status?
 
 Error status code, default to 500
 
+`string` | `number`
+
 ## Returns
 
 `void`
@@ -31,7 +39,3 @@ Error status code, default to 500
 ## Throws
 
 Throws a BaseError object
-
-## Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:161

package/docs/functions/toDate.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,6 +8,8 @@
 
 > **toDate**\<`DateType`, `ResultDate`\>(`argument`, `context`?): `ResultDate`
 
+Defined in: node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/toDate.d.ts:40
+
 ## Type Parameters
 
 • **DateType** *extends* `Date` \| `ConstructableDate`
@@ -20,11 +22,15 @@ The result `Date` type, it is the type returned from the context function if it
 
 ## Parameters
 
-• **argument**: `DateArg`\<`DateType`\>
+### argument
+
+`DateArg`\<`DateType`\>
 
 The value to convert
 
-• **context?**: `ContextFn`\<`ResultDate`\>
+### context?
+
+`ContextFn`\<`ResultDate`\>
 
 ## Returns
 
@@ -36,10 +42,6 @@ The parsed date in the local time zone
 
 toDate
 
-## Summary
-
-Convert the given argument to an instance of Date.
-
 ## Description
 
 Convert the given argument to an instance of Date.
@@ -70,7 +72,3 @@ const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
 const result = toDate(1392098430000)
 //=> Tue Feb 11 2014 11:30:30
 ```
-
-## Defined in
-
-node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/toDate.d.ts:40

package/docs/functions/toDateTime.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **toDateTime**(`date`): `undefined` \| `Date`
 
+Defined in: [packages/ai-tool/src/utils/to-datetime.ts:9](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/to-datetime.ts#L9)
+
 ## Parameters
 
-• **date**: `string` \| `number` \| `Date`
+### date
+
+`string` | `number` | `Date`
 
 ## Returns
 
 `undefined` \| `Date`
-
-## Defined in
-
-[packages/ai-tool/src/utils/to-datetime.ts:9](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/to-datetime.ts#L9)