@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/functions/hfTokenize.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,18 +8,20 @@
 
 > **hfTokenize**(`source`, `options`): `Token`[]
 
+Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/lexer.ts:203](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/jinja/src/lexer.ts#L203)
+
 Generate a list of tokens from a source string.
 
 ## Parameters
 
-• **source**: `string`
+### source
 
-• **options**: `PreprocessOptions` = `{}`
+`string`
 
-## Returns
+### options
 
-`Token`[]
+`PreprocessOptions` = `{}`
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/prompt/template/jinja/src/lexer.ts:200](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/jinja/src/lexer.ts#L200)
+`Token`[]

package/docs/functions/initShutdown.md

@@ -0,0 +1,15 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / initShutdown
+
+# Function: initShutdown()
+
+> **initShutdown**(): `void`
+
+Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:103](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/node/before-shutdown.ts#L103)
+
+## Returns
+
+`void`

package/docs/functions/interpolateEnv.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,20 +6,24 @@
 
 # Function: interpolateEnv()
 
-> **interpolateEnv**(`value`, `processEnv`, `parsed`): `any`
+> **interpolateEnv**(`value`, `processEnv`, `parsed`?): `any`
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L31)
 
 ## Parameters
 
-• **value**: `string`
+### value
 
-• **processEnv**: `any`
+`string`
 
-• **parsed**: `any`
+### processEnv
 
-## Returns
+`Record`\<`string`, `any`\>
 
-`any`
+### parsed?
 
-## Defined in
+`Record`\<`string`, `any`\>
 
-[packages/ai-tool/src/utils/prompt/template/env.ts:17](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L17)
+## Returns
+
+`any`

package/docs/functions/interpolateFString.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,20 +8,22 @@
 
 > **interpolateFString**(`nodes`, `values`): `string`
 
+Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:71](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/python.ts#L71)
+
 Type that represents a function that takes a template string and a set
 of input values, and returns a string where all variables in the
 template have been replaced with their corresponding values.
 
 ## Parameters
 
-• **nodes**: [`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
+### nodes
 
-• **values**: `Record`\<`string`, `any`\>
+[`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
 
-## Returns
+### values
 
-`string`
+`Record`\<`string`, `any`\>
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/prompt/template/python.ts:71](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/python.ts#L71)
+`string`

package/docs/functions/interpolateGolangTemplate.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,24 +8,28 @@
 
 > **interpolateGolangTemplate**(`str`, `variables`, `initVars`?): `string`
 
+Defined in: [packages/ai-tool/src/utils/prompt/template/golang.ts:269](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/golang.ts#L269)
+
 Parse and interpolate template
 
 ## Parameters
 
-• **str**: `string`
+### str
+
+`string`
 
 golang style template
 
-• **variables**: `Record`\<`string`, `any`\>
+### variables
+
+`Record`\<`string`, `any`\>
 
 object of variables to insert
 
-• **initVars?**: `boolean`
+### initVars?
+
+`boolean`
 
 ## Returns
 
 `string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/golang.ts:269](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/golang.ts#L269)

package/docs/functions/isLangUsingSpaces.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **isLangUsingSpaces**(`isoCode`): `boolean`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:260](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L260)
+
 ## Parameters
 
-• **isoCode**: `string`
+### isoCode
+
+`string`
 
 ## Returns
 
 `boolean`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:260](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L260)

package/docs/functions/isListItemString.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **isListItemString**(`text`): `null` \| `RegExpExecArray`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:223](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L223)
+
 ## Parameters
 
-• **text**: `string`
+### text
+
+`string`
 
 ## Returns
 
 `null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:223](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L223)

package/docs/functions/isModelNameMatched.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,15 +8,21 @@
 
 > **isModelNameMatched**(`modelName`, `rule`?): `undefined` \| `string` \| `RegExpExecArray`
 
+Defined in: [packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/is-model-name-matched.ts#L21)
+
 Checks if the provided model name matches the given rule.
 
 ## Parameters
 
-• **modelName**: `string`
+### modelName
+
+`string`
 
 The name of the model to check.
 
-• **rule?**: [`AIModelNameRules`](../type-aliases/AIModelNameRules.md)
+### rule?
+
+[`AIModelNameRules`](../type-aliases/AIModelNameRules.md)
 
 An optional rule that can be a string, an array of strings, a regular expression, or a function.
 
@@ -39,7 +45,3 @@ IsModelNameMatched("gpt-2", ["gpt-3", "gpt-4"]) // returns false
 IsModelNameMatched("gpt-2", /^gpt-\d+$/) // returns false
 IsModelNameMatched("gpt-2", (modelName) => modelName.startsWith("gpt-")) // returns false
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/is-model-name-matched.ts#L21)

package/docs/functions/isPunctuationChar.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,12 +8,16 @@
 
 > **isPunctuationChar**(`char`): `boolean`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:245](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L245)
+
 Checks if the given character is a punctuation mark.
 This function supports both Chinese and English punctuation marks.
 
 ## Parameters
 
-• **char**: `string`
+### char
+
+`string`
 
 The character to check.
 
@@ -30,7 +34,3 @@ isPunctuationChar('。'); // returns true
 isPunctuationChar('!');  // returns true
 isPunctuationChar('a');  // returns false
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:245](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L245)

package/docs/functions/isQuoted.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isQuoted
+
+# Function: isQuoted()
+
+> **isQuoted**(`s`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:195](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/parse-command.ts#L195)
+
+## Parameters
+
+### s
+
+`string`
+
+## Returns
+
+`boolean`

package/docs/functions/isRegExp.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **isRegExp**(`value`): `boolean`
 
+Defined in: [packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/isRegExp.ts#L3)
+
 ## Parameters
 
-• **value**: `any`
+### value
+
+`any`
 
 ## Returns
 
 `boolean`
-
-## Defined in
-
-[packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/isRegExp.ts#L3)

package/docs/functions/isSameString.md

@@ -0,0 +1,36 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isSameString
+
+# Function: isSameString()
+
+> **isSameString**(`str1`, `str2`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/is-same-string.ts:13](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/is-same-string.ts#L13)
+
+Compares two strings to check if they are the same.
+
+This function first checks if the strings have the same length. If they do, it compares the strings character by character.
+If the strings are not the same length, it returns false immediately.
+
+## Parameters
+
+### str1
+
+`string`
+
+The first string to compare.
+
+### str2
+
+`string`
+
+The second string to compare.
+
+## Returns
+
+`boolean`
+
+A boolean indicating whether the two strings are the same.

package/docs/functions/isSectionString.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **isSectionString**(`text`, `options`?): `null` \| `RegExpExecArray`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L197)
+
 ## Parameters
 
-• **text**: `string`
+### text
 
-• **options?**: [`SectionStringOptions`](../interfaces/SectionStringOptions.md)
+`string`
 
-## Returns
+### options?
 
-`null` \| `RegExpExecArray`
+[`SectionStringOptions`](../interfaces/SectionStringOptions.md)
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L197)
+`null` \| `RegExpExecArray`

package/docs/functions/isSentenceEnding.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **isSentenceEnding**(`text`): `boolean`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L187)
+
 ## Parameters
 
-• **text**: `string`
+### text
+
+`string`
 
 ## Returns
 
 `boolean`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L187)

package/docs/functions/isSepLineString.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **isSepLineString**(`text`): `null` \| `RegExpExecArray`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L227)
+
 ## Parameters
 
-• **text**: `string`
+### text
+
+`string`
 
 ## Returns
 
 `null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L227)

package/docs/functions/isStrWrapped.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isStrWrapped
+
+# Function: isStrWrapped()
+
+> **isStrWrapped**(`s`, `pairs`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:200](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/parse-command.ts#L200)
+
+## Parameters
+
+### s
+
+`string`
+
+### pairs
+
+`string`[] = `...`
+
+## Returns
+
+`boolean`

package/docs/functions/isSubdirectory.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,15 +8,21 @@
 
 > **isSubdirectory**(`parentDir`, `childDir`): `boolean`
 
+Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:17](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/has-directory-in.ts#L17)
+
 Determines whether the `childDir` is a subdirectory of `parentDir`.
 
 ## Parameters
 
-• **parentDir**: `string`
+### parentDir
+
+`string`
 
 The directory to check as the potential parent.
 
-• **childDir**: `string`
+### childDir
+
+`string`
 
 The directory to check as the potential child.
 
@@ -33,7 +39,3 @@ const parentDir = '/usr/local';
 const childDir = '/usr/local/include';
 const result = isSubdirectory(parentDir, childDir); // true
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/has-directory-in.ts:17](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/has-directory-in.ts#L17)

package/docs/functions/isTitleString.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,16 +8,18 @@
 
 > **isTitleString**(`text`, `options`?): `null` \| `RegExpExecArray`
 
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:204](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L204)
+
 ## Parameters
 
-• **text**: `string`
+### text
 
-• **options?**: [`SectionStringOptions`](../interfaces/SectionStringOptions.md)
+`string`
 
-## Returns
+### options?
 
-`null` \| `RegExpExecArray`
+[`SectionStringOptions`](../interfaces/SectionStringOptions.md)
 
-## Defined in
+## Returns
 
-[packages/ai-tool/src/utils/split-sentence.ts:204](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/split-sentence.ts#L204)
+`null` \| `RegExpExecArray`

package/docs/functions/isValidFilename.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,11 +8,15 @@
 
 > **isValidFilename**(`filename`): `boolean` \| `""`
 
+Defined in: [packages/ai-tool/src/utils/filename.ts:63](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/filename.ts#L63)
+
 Validates if a given string is a valid filename.
 
 ## Parameters
 
-• **filename**: `string`
+### filename
+
+`string`
 
 The filename to be validated.
 
@@ -32,7 +36,3 @@ If the input is not a string.
 isValidFilename('myFile.txt'); // Returns true
 isValidFilename('my<file.txt'); // Returns false
 ```
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:63](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L63)

package/docs/functions/isValidFilepath.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,11 +8,15 @@
 
 > **isValidFilepath**(`filepath`): `boolean`
 
+Defined in: [packages/ai-tool/src/utils/filename.ts:72](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/filename.ts#L72)
+
 Validates whether the given filepath is valid.
 
 ## Parameters
 
-• **filepath**: `string`
+### filepath
+
+`string`
 
 The filepath to be checked, represented as a string.
 
@@ -21,7 +25,3 @@ The filepath to be checked, represented as a string.
 `boolean`
 
 A boolean indicating whether the filepath is valid. Returns true if valid; false otherwise.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:72](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/filename.ts#L72)

package/docs/functions/isWebStream.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -8,14 +8,14 @@
 
 > **isWebStream**(`val`): val is ReadableStream\<any\> \| WritableStream\<any\>
 
+Defined in: [packages/ai-tool/src/utils/stream/is-web-stream.ts:1](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/is-web-stream.ts#L1)
+
 ## Parameters
 
-• **val**: `any`
+### val
+
+`any`
 
 ## Returns
 
 val is ReadableStream\<any\> \| WritableStream\<any\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/is-web-stream.ts:1](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/stream/is-web-stream.ts#L1)