@isdk/ai-tool 0.5.2 → 0.5.3

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/79d5773fa454dc7789b1291b1ebd73e4c1b93154/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

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isSectionString
+
+# Function: isSectionString()
+
+> **isSectionString**(`text`, `options`?): `null` \| `RegExpExecArray`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L197)
+
+## Parameters
+
+### text
+
+`string`
+
+### options?
+
+[`SectionStringOptions`](../interfaces/SectionStringOptions.md)
+
+## Returns
+
+`null` \| `RegExpExecArray`

package/docs/functions/isSentenceEnding.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isSentenceEnding
+
+# Function: isSentenceEnding()
+
+> **isSentenceEnding**(`text`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L187)
+
+## Parameters
+
+### text
+
+`string`
+
+## Returns
+
+`boolean`

package/docs/functions/isSepLineString.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isSepLineString
+
+# Function: isSepLineString()
+
+> **isSepLineString**(`text`): `null` \| `RegExpExecArray`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L227)
+
+## Parameters
+
+### text
+
+`string`
+
+## Returns
+
+`null` \| `RegExpExecArray`

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/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L200)
+
+## Parameters
+
+### s
+
+`string`
+
+### pairs
+
+`string`[] = `...`
+
+## Returns
+
+`boolean`

package/docs/functions/isSubdirectory.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isSubdirectory
+
+# Function: isSubdirectory()
+
+> **isSubdirectory**(`parentDir`, `childDir`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:17](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/has-directory-in.ts#L17)
+
+Determines whether the `childDir` is a subdirectory of `parentDir`.
+
+## Parameters
+
+### parentDir
+
+`string`
+
+The directory to check as the potential parent.
+
+### childDir
+
+`string`
+
+The directory to check as the potential child.
+
+## Returns
+
+`boolean`
+
+true if `childDir` is a subdirectory of `parentDir`, otherwise false.
+
+## Example
+
+```typescript
+const parentDir = '/usr/local';
+const childDir = '/usr/local/include';
+const result = isSubdirectory(parentDir, childDir); // true
+```

package/docs/functions/isTitleString.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isTitleString
+
+# Function: isTitleString()
+
+> **isTitleString**(`text`, `options`?): `null` \| `RegExpExecArray`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:204](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L204)
+
+## Parameters
+
+### text
+
+`string`
+
+### options?
+
+[`SectionStringOptions`](../interfaces/SectionStringOptions.md)
+
+## Returns
+
+`null` \| `RegExpExecArray`

package/docs/functions/isValidFilename.md

@@ -0,0 +1,38 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isValidFilename
+
+# Function: isValidFilename()
+
+> **isValidFilename**(`filename`): `boolean` \| `""`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:63](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/filename.ts#L63)
+
+Validates if a given string is a valid filename.
+
+## Parameters
+
+### filename
+
+`string`
+
+The filename to be validated.
+
+## Returns
+
+`boolean` \| `""`
+
+True if the filename is valid, false otherwise.
+
+## Throws
+
+If the input is not a string.
+
+## Example
+
+```ts
+isValidFilename('myFile.txt'); // Returns true
+isValidFilename('my<file.txt'); // Returns false
+```

package/docs/functions/isValidFilepath.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isValidFilepath
+
+# Function: isValidFilepath()
+
+> **isValidFilepath**(`filepath`): `boolean`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:72](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/filename.ts#L72)
+
+Validates whether the given filepath is valid.
+
+## Parameters
+
+### filepath
+
+`string`
+
+The filepath to be checked, represented as a string.
+
+## Returns
+
+`boolean`
+
+A boolean indicating whether the filepath is valid. Returns true if valid; false otherwise.

package/docs/functions/isWebStream.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / isWebStream
+
+# Function: isWebStream()
+
+> **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/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/is-web-stream.ts#L1)
+
+## Parameters
+
+### val
+
+`any`
+
+## Returns
+
+val is ReadableStream\<any\> \| WritableStream\<any\>

package/docs/functions/jsonFilterToWhere.md

@@ -0,0 +1,47 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / jsonFilterToWhere
+
+# Function: jsonFilterToWhere()
+
+> **jsonFilterToWhere**(`filter`, `wrapKey`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/json-filter.ts:123](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/json-filter.ts#L123)
+
+Converts a filter object to a SQLite WHERE clause.
+
+## Parameters
+
+### filter
+
+The filter object to convert.
+
+[`JsonFilter`](../interfaces/JsonFilter.md) | [`JsonFilter`](../interfaces/JsonFilter.md)[]
+
+### wrapKey?
+
+(`k`) => `string`
+
+## Returns
+
+`string`
+
+The generated WHERE clause.
+
+## Example
+
+```ts
+const jsonFilter: Filter = {
+  $and: [
+    { age: { $gt: 18, $lt: 30 } },
+    { name: { $like: 'John%', $nlike: 'Doe%' } },
+    { hobbies: { $in: ['reading', 'writing'] } },
+    { $or: [{ gender: 'male' }, { country: 'USA' }] },
+    { $and: [{ status: 'active' }, { registered: new Date('2020-01-01') }] },
+  ],
+};
+
+console.log(jsonFilterToWhere(jsonFilter)); // Outputs a WHERE clause based on the given filter
+```

package/docs/functions/jsonToMarkdownStr.md

@@ -0,0 +1,39 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / jsonToMarkdownStr
+
+# Function: jsonToMarkdownStr()
+
+> **jsonToMarkdownStr**(`mem`, `options`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/json-to-markdown-str.ts:2](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/json-to-markdown-str.ts#L2)
+
+## Parameters
+
+### mem
+
+`any`
+
+### options?
+
+#### arrayTag?
+
+`string`
+
+#### level?
+
+`number`
+
+#### objectTag?
+
+`string`
+
+#### visiting?
+
+`Set`\<`any`\>
+
+## Returns
+
+`string`

package/docs/functions/loadAIConfig.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadAIConfig
+
+# Function: loadAIConfig()
+
+> **loadAIConfig**(`config`): `any`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:53](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-config.ts#L53)
+
+## Parameters
+
+### config
+
+`any`
+
+## Returns
+
+`any`

package/docs/functions/loadConfig.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadConfig
+
+# Function: loadConfig()
+
+> **loadConfig**(`filename`, `config`): `any`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-config.ts#L27)
+
+## Parameters
+
+### filename
+
+`string`
+
+### config
+
+`any`
+
+## Returns
+
+`any`

package/docs/functions/loadConfigFile.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadConfigFile
+
+# Function: loadConfigFile()
+
+> **loadConfigFile**(`filename`, `searchPaths`): `any`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-config.ts#L9)
+
+## Parameters
+
+### filename
+
+`string`
+
+### searchPaths
+
+`string`[] = `...`
+
+## Returns
+
+`any`

package/docs/functions/loadFileFromPaths.md

@@ -0,0 +1,64 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadFileFromPaths
+
+# Function: loadFileFromPaths()
+
+> **loadFileFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?): `Buffer`\<`ArrayBufferLike`\>
+
+Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:44](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-file-from-paths.ts#L44)
+
+Loads a file from given paths, optionally searching for specific extensions.
+
+## Parameters
+
+### filename
+
+`string`
+
+The base filename to search for, without any file extension.
+
+### searchPaths?
+
+`string`[]
+
+An array of directories to search for the file. Defaults to the current directory (`"."`) if not provided.
+
+### extNames?
+
+`string`[]
+
+An array of file extensions to try, in order of preference. If not provided, the file will be searched for
+                  without any extension.
+
+### options?
+
+#### exclude?
+
+`string` \| `string`[]
+
+#### filepath?
+
+`string`
+
+#### signal?
+
+`AbortSignal`
+
+## Returns
+
+`Buffer`\<`ArrayBufferLike`\>
+
+The contents of the found file as a Buffer.
+
+## Throws
+
+If the file is not found in any of the search paths.
+
+## Example
+
+```typescript
+const content = loadFileFromPaths('config', ['/etc', '/usr/local/etc'], ['.json', '.yaml']);
+```

package/docs/functions/loadTextFromPaths.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / loadTextFromPaths
+
+# Function: loadTextFromPaths()
+
+> **loadTextFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?, `exclude`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:101](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-file-from-paths.ts#L101)
+
+## Parameters
+
+### filename
+
+`string`
+
+### searchPaths?
+
+`string`[]
+
+### extNames?
+
+`string`[]
+
+### options?
+
+`BufferEncoding` | \{ `encoding`: BufferEncoding \| undefined; `filepath`: `string`; `signal`: `AbortSignal`; \}
+
+### exclude?
+
+`string` | `string`[]
+
+## Returns
+
+`string`

package/docs/functions/lrucache.md

@@ -0,0 +1,35 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / \_lrucache
+
+# Function: \_lrucache()
+
+> **\_lrucache**(`this`, `__namedParameters`): `Cache`
+
+Defined in: [packages/ai-tool/src/funcs/lrucache.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/lrucache.ts#L8)
+
+## Parameters
+
+### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+### \_\_namedParameters
+
+#### key?
+
+`string`
+
+#### options?
+
+`number` \| `ICacheOptions`
+
+#### value?
+
+`any`
+
+## Returns
+
+`Cache`

package/docs/functions/makeToolFuncCancelable.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / makeToolFuncCancelable
+
+# Function: makeToolFuncCancelable()
+
+> **makeToolFuncCancelable**\<`T`\>(`targetClass`?, `options`?): `EnhancedClass`\<`T`, *typeof* [`CancelableAbility`](../classes/CancelableAbility.md)\>
+
+Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:382](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L382)
+
+## Type Parameters
+
+• **T** *extends* `ClassEx`
+
+## Parameters
+
+### targetClass?
+
+`T`
+
+### options?
+
+`AbilityOptions`
+
+## Returns
+
+`EnhancedClass`\<`T`, *typeof* [`CancelableAbility`](../classes/CancelableAbility.md)\>

package/docs/functions/matchUrlProtocol.md

@@ -0,0 +1,48 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / matchUrlProtocol
+
+# Function: matchUrlProtocol()
+
+> **matchUrlProtocol**(`name`): `undefined` \| `string`
+
+Defined in: [packages/ai-tool/src/utils/match-url-protocol.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/match-url-protocol.ts#L23)
+
+Extracts the protocol part from a URL-like string.
+
+This function checks a given string to find the protocol section of a URL.
+If the string contains the sequence '://', it returns the substring from the start of the string
+up to the '//' characters. If the sequence is not found, the function returns undefined.
+
+## Parameters
+
+### name
+
+`string`
+
+The string to inspect, expected to contain a URL.
+
+## Returns
+
+`undefined` \| `string`
+
+- The protocol part if '://' is found; otherwise, undefined.
+
+## Examples
+
+```ts
+// Returns "http"
+matchUrlProtocol("http://example.com");
+```
+
+```ts
+// Returns "ftp"
+matchUrlProtocol("ftp://myftpserver.com");
+```
+
+```ts
+// Returns undefined
+matchUrlProtocol("noProtocolHere");
+```