@isdk/ai-tool 0.5.8 → 0.6.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 (292) hide show
  1. package/dist/chunk-OYDBRUZJ.mjs +1 -0
  2. package/dist/funcs.js +1 -1
  3. package/dist/funcs.mjs +1 -1
  4. package/dist/index.d.mts +11 -637
  5. package/dist/index.d.ts +11 -637
  6. package/dist/index.js +1 -1
  7. package/dist/index.mjs +1 -1
  8. package/docs/classes/BinarySemaphore.md +25 -25
  9. package/docs/classes/CancelableAbility.md +25 -25
  10. package/docs/classes/ClientTools.md +57 -57
  11. package/docs/classes/ConfigFile.md +78 -262
  12. package/docs/classes/EnvPromptTemplate.md +233 -36
  13. package/docs/classes/EventClient.md +80 -80
  14. package/docs/classes/EventServer.md +81 -81
  15. package/docs/classes/EventToolFunc.md +49 -49
  16. package/docs/classes/FStringPromptTemplate.md +234 -37
  17. package/docs/classes/FewShotPromptTemplate.md +213 -34
  18. package/docs/classes/GolangPromptTemplate.md +230 -33
  19. package/docs/classes/IntSet.md +12 -12
  20. package/docs/classes/PromptExampleSelector.md +9 -9
  21. package/docs/classes/PromptTemplate.md +230 -34
  22. package/docs/classes/ReadableStreamError.md +2 -2
  23. package/docs/classes/ResClientTools.md +64 -64
  24. package/docs/classes/ResServerTools.md +65 -65
  25. package/docs/classes/SSEChannel.md +16 -16
  26. package/docs/classes/Semaphore.md +26 -26
  27. package/docs/classes/ServerTools.md +53 -53
  28. package/docs/classes/SignalGate.md +9 -9
  29. package/docs/classes/TaskAbortController.md +8 -8
  30. package/docs/classes/ToolFunc.md +46 -46
  31. package/docs/classes/YamlTypeBaseObject.md +2 -2
  32. package/docs/enumerations/AsyncFeatureBits.md +4 -4
  33. package/docs/enumerations/AsyncFeatures.md +4 -4
  34. package/docs/enumerations/HashAlgorithm.md +12 -12
  35. package/docs/functions/AIArgProcessor.md +1 -1
  36. package/docs/functions/AIStream.md +1 -1
  37. package/docs/functions/ChoiceArgProcessor.md +1 -1
  38. package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
  39. package/docs/functions/RateLimit.md +1 -1
  40. package/docs/functions/TemplateArgProcessor.md +1 -1
  41. package/docs/functions/assignDirs.md +1 -1
  42. package/docs/functions/backendEventable.md +1 -1
  43. package/docs/functions/beforeShutdown.md +1 -1
  44. package/docs/functions/completeSentences.md +1 -1
  45. package/docs/functions/concatText.md +1 -1
  46. package/docs/functions/countLLMTokens.md +1 -1
  47. package/docs/functions/countRegexMatches.md +1 -1
  48. package/docs/functions/createCallbacksTransformer.md +1 -1
  49. package/docs/functions/createEmptyReadableStream.md +1 -1
  50. package/docs/functions/createEndWithRepetitionDetector.md +1 -1
  51. package/docs/functions/createEventStreamTransformer.md +1 -1
  52. package/docs/functions/createHfValueFunc.md +1 -1
  53. package/docs/functions/createLRUCache.md +1 -1
  54. package/docs/functions/createYamlObjectTag.md +1 -1
  55. package/docs/functions/dateToText.md +1 -1
  56. package/docs/functions/decodeCharset.md +1 -1
  57. package/docs/functions/detectCharset.md +1 -1
  58. package/docs/functions/encodeLLMTokens.md +1 -1
  59. package/docs/functions/ensureQuoted.md +1 -1
  60. package/docs/functions/expandConfig.md +3 -3
  61. package/docs/functions/expandEnv.md +4 -4
  62. package/docs/functions/expandObjEnv.md +4 -4
  63. package/docs/functions/expandPath.md +1 -1
  64. package/docs/functions/extNameLevel.md +1 -1
  65. package/docs/functions/fileIsExists.md +1 -1
  66. package/docs/functions/filterValidFnScope.md +1 -1
  67. package/docs/functions/findIndexNonEmptyFrom.md +1 -1
  68. package/docs/functions/findPort.md +1 -1
  69. package/docs/functions/formatTextWithSpace.md +1 -1
  70. package/docs/functions/getAllEnumKeys.md +1 -1
  71. package/docs/functions/getConfigFileNames.md +1 -1
  72. package/docs/functions/getConfigs.md +1 -1
  73. package/docs/functions/getEnvVairables.md +1 -1
  74. package/docs/functions/getFileMetaInfo.md +1 -1
  75. package/docs/functions/getHashAlgoBySize.md +1 -1
  76. package/docs/functions/getKeysPath.md +1 -1
  77. package/docs/functions/getLLMTokenizer.md +1 -1
  78. package/docs/functions/getMultiLevelExtname.md +4 -4
  79. package/docs/functions/getPackageDir.md +1 -1
  80. package/docs/functions/getRealFilepath.md +1 -1
  81. package/docs/functions/getResponseErrorReadableStream.md +1 -1
  82. package/docs/functions/getXDGConfigs.md +1 -1
  83. package/docs/functions/hasDirectoryIn.md +1 -1
  84. package/docs/functions/hash.md +1 -1
  85. package/docs/functions/hashFile.md +1 -1
  86. package/docs/functions/hashStream.md +1 -1
  87. package/docs/functions/initShutdown.md +1 -1
  88. package/docs/functions/isLangUsingSpaces.md +1 -1
  89. package/docs/functions/isListItemString.md +1 -1
  90. package/docs/functions/isModelNameMatched.md +1 -1
  91. package/docs/functions/isPunctuationChar.md +1 -1
  92. package/docs/functions/isQuoted.md +1 -1
  93. package/docs/functions/isRegExp.md +1 -1
  94. package/docs/functions/isSameString.md +1 -1
  95. package/docs/functions/isSectionString.md +1 -1
  96. package/docs/functions/isSentenceEnding.md +1 -1
  97. package/docs/functions/isSepLineString.md +1 -1
  98. package/docs/functions/isStrWrapped.md +1 -1
  99. package/docs/functions/isSubdirectory.md +1 -1
  100. package/docs/functions/isTitleString.md +1 -1
  101. package/docs/functions/isValidFilename.md +1 -1
  102. package/docs/functions/isValidFilepath.md +1 -1
  103. package/docs/functions/isWebStream.md +1 -1
  104. package/docs/functions/jsonFilterToWhere.md +1 -1
  105. package/docs/functions/jsonToMarkdownStr.md +1 -1
  106. package/docs/functions/loadAIConfig.md +1 -1
  107. package/docs/functions/loadConfig.md +1 -1
  108. package/docs/functions/loadConfigFile.md +1 -1
  109. package/docs/functions/loadFileFromPaths.md +1 -1
  110. package/docs/functions/loadTextFromPaths.md +1 -1
  111. package/docs/functions/lrucache.md +1 -1
  112. package/docs/functions/makeToolFuncCancelable.md +1 -1
  113. package/docs/functions/matchUrlProtocol.md +1 -1
  114. package/docs/functions/memoize.md +1 -1
  115. package/docs/functions/messagesToText.md +1 -1
  116. package/docs/functions/paramsSizeToScaleStr.md +1 -1
  117. package/docs/functions/parseCommand.md +1 -1
  118. package/docs/functions/parseJsJson.md +1 -1
  119. package/docs/functions/parseJsJsonSimpleSync.md +1 -1
  120. package/docs/functions/parseObjectArgInfo.md +1 -1
  121. package/docs/functions/parseObjectArgumentInfos.md +1 -1
  122. package/docs/functions/parseObjectArguments.md +1 -1
  123. package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
  124. package/docs/functions/parseYaml.md +21 -1
  125. package/docs/functions/quoteStr.md +1 -1
  126. package/docs/functions/readFilenamesRecursiveSync.md +7 -1
  127. package/docs/functions/readTextFileChunks.md +1 -1
  128. package/docs/functions/readTextFileChunksEx.md +1 -1
  129. package/docs/functions/readableFromAsyncIterable.md +1 -1
  130. package/docs/functions/registerCoreTools.md +1 -1
  131. package/docs/functions/registerYamlTag.md +18 -2
  132. package/docs/functions/removeMarkdownBold.md +1 -1
  133. package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
  134. package/docs/functions/removeMarkdownItalic.md +1 -1
  135. package/docs/functions/replaceWithPlaceholder.md +1 -1
  136. package/docs/functions/restoreFromPlacehoders.md +1 -1
  137. package/docs/functions/sanitizeFilename.md +4 -4
  138. package/docs/functions/sanitizeFilepath.md +4 -4
  139. package/docs/functions/saveConfigFile.md +1 -1
  140. package/docs/functions/scaleStrToParamsSize.md +1 -1
  141. package/docs/functions/shutdown.md +1 -1
  142. package/docs/functions/simplifyObjectArguments.md +1 -1
  143. package/docs/functions/sortedValues.md +1 -1
  144. package/docs/functions/splitChunks.md +1 -1
  145. package/docs/functions/splitParagraph.md +1 -1
  146. package/docs/functions/splitSentence.md +1 -1
  147. package/docs/functions/stringifyYaml.md +21 -1
  148. package/docs/functions/stripConsoleColor.md +1 -1
  149. package/docs/functions/textToDate.md +1 -1
  150. package/docs/functions/toDateTime.md +1 -1
  151. package/docs/functions/trimStartOfStreamHelper.md +1 -1
  152. package/docs/functions/truncTo.md +1 -1
  153. package/docs/functions/truncateByToken.md +1 -1
  154. package/docs/functions/truncateToTokenLimit.md +1 -1
  155. package/docs/functions/truncateToTokenLimitEx.md +1 -1
  156. package/docs/functions/uuid.md +1 -1
  157. package/docs/functions/wait.md +1 -1
  158. package/docs/functions/xxhash.md +1 -1
  159. package/docs/functions/xxhash32.md +1 -1
  160. package/docs/functions/xxhash64.md +1 -1
  161. package/docs/functions/xxhashAsStr.md +1 -1
  162. package/docs/globals.md +0 -23
  163. package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
  164. package/docs/interfaces/AIChatContentPartImage.md +3 -3
  165. package/docs/interfaces/AIChatContentPartText.md +3 -3
  166. package/docs/interfaces/AIChatMessageParamBase.md +7 -7
  167. package/docs/interfaces/AIChatMessageToolCall.md +4 -4
  168. package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
  169. package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  170. package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
  171. package/docs/interfaces/AIChatToolFunc.md +5 -5
  172. package/docs/interfaces/AIChatToolFuncParam.md +3 -3
  173. package/docs/interfaces/AIChatToolMessageParam.md +10 -10
  174. package/docs/interfaces/AIChatToolParam.md +2 -2
  175. package/docs/interfaces/AIChatToolTypeObject.md +2 -2
  176. package/docs/interfaces/AIChatUserMessageParam.md +13 -13
  177. package/docs/interfaces/AIChoiceConfig.md +8 -8
  178. package/docs/interfaces/AIResult.md +6 -6
  179. package/docs/interfaces/AIStreamParser.md +2 -2
  180. package/docs/interfaces/AIStreamParserOptions.md +2 -2
  181. package/docs/interfaces/BaseFunc.md +11 -11
  182. package/docs/interfaces/BaseFuncItem.md +10 -10
  183. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  184. package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
  185. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  186. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  187. package/docs/interfaces/CancelableAbilityOptions.md +4 -4
  188. package/docs/interfaces/ClientFuncItem.md +13 -13
  189. package/docs/interfaces/EventClientFuncParams.md +5 -5
  190. package/docs/interfaces/EventServerFuncParams.md +6 -6
  191. package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
  192. package/docs/interfaces/FuncItem.md +11 -11
  193. package/docs/interfaces/FuncParam.md +7 -7
  194. package/docs/interfaces/FuncParams.md +1 -1
  195. package/docs/interfaces/Funcs.md +1 -1
  196. package/docs/interfaces/HashAlgoParams.md +4 -4
  197. package/docs/interfaces/IFileMetaInfo.md +8 -8
  198. package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
  199. package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
  200. package/docs/interfaces/JsonFilter.md +1 -1
  201. package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
  202. package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
  203. package/docs/interfaces/PromptTemplateOptions.md +7 -7
  204. package/docs/interfaces/RemoteFuncItem.md +13 -13
  205. package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
  206. package/docs/interfaces/ResClientFuncParams.md +3 -3
  207. package/docs/interfaces/ResServerFuncParams.md +6 -6
  208. package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
  209. package/docs/interfaces/SectionStringOptions.md +3 -3
  210. package/docs/interfaces/SemaphoreOptions.md +7 -7
  211. package/docs/interfaces/SemaphoreTaskItem.md +5 -5
  212. package/docs/interfaces/ServerFuncItem.md +14 -14
  213. package/docs/interfaces/ServerFuncParams.md +3 -3
  214. package/docs/interfaces/SplitSentenceOptions.md +5 -5
  215. package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
  216. package/docs/interfaces/TaskAbortControllers.md +1 -1
  217. package/docs/interfaces/TaskPromise.md +2 -2
  218. package/docs/interfaces/ToolFuncPackage.md +4 -4
  219. package/docs/type-aliases/AIChatContentPart.md +1 -1
  220. package/docs/type-aliases/AIChatMessageParam.md +1 -1
  221. package/docs/type-aliases/AIChatRole.md +1 -1
  222. package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
  223. package/docs/type-aliases/AIMessageType.md +1 -1
  224. package/docs/type-aliases/AIModelNameRule.md +1 -1
  225. package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
  226. package/docs/type-aliases/AIModelNameRules.md +1 -1
  227. package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
  228. package/docs/type-aliases/ActionName.md +1 -1
  229. package/docs/type-aliases/AsyncTaskId.md +1 -1
  230. package/docs/type-aliases/BeforeShutdownListener.md +1 -1
  231. package/docs/type-aliases/EventErrorListenerFn.md +1 -1
  232. package/docs/type-aliases/EventListenerFn.md +1 -1
  233. package/docs/type-aliases/FuncParamType.md +1 -1
  234. package/docs/type-aliases/PromptExamples.md +1 -1
  235. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  236. package/docs/type-aliases/TFunc.md +1 -1
  237. package/docs/variables/AIChatRoles.md +1 -1
  238. package/docs/variables/AIMessageTypes.md +1 -1
  239. package/docs/variables/AITextGenerationFinishReasons.md +1 -1
  240. package/docs/variables/ActionNames.md +1 -1
  241. package/docs/variables/ClientToolFuncSchema.md +1 -1
  242. package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
  243. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  244. package/docs/variables/EventBusName.md +1 -1
  245. package/docs/variables/EventName.md +1 -1
  246. package/docs/variables/FilenameReservedRegex.md +1 -1
  247. package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
  248. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  249. package/docs/variables/PASSING_SCORE.md +1 -1
  250. package/docs/variables/RStreamErrCode.md +1 -1
  251. package/docs/variables/RemoteToolFuncSchema.md +1 -1
  252. package/docs/variables/ResponseRStreamErrCode.md +1 -1
  253. package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
  254. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  255. package/docs/variables/SecondaryCache.md +1 -1
  256. package/docs/variables/ServerToolFuncSchema.md +1 -1
  257. package/docs/variables/ToolAsyncCancelableBit.md +1 -1
  258. package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
  259. package/docs/variables/ToolAsyncPriorityBit.md +1 -1
  260. package/docs/variables/ToolFuncSchema.md +1 -1
  261. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  262. package/docs/variables/base32768.md +1 -1
  263. package/docs/variables/defaultTemplateFormat.md +2 -2
  264. package/docs/variables/event.md +1 -1
  265. package/docs/variables/eventClient.md +1 -1
  266. package/docs/variables/eventServer.md +1 -1
  267. package/docs/variables/lrucache.md +1 -1
  268. package/package.json +5 -3
  269. package/dist/chunk-YVFGQB4L.mjs +0 -1
  270. package/docs/classes/HFEnvironment.md +0 -184
  271. package/docs/classes/HFInterpreter.md +0 -77
  272. package/docs/classes/HFTemplate.md +0 -67
  273. package/docs/classes/HfPromptTemplate.md +0 -1158
  274. package/docs/functions/filenameReservedRegex.md +0 -20
  275. package/docs/functions/hfParse.md +0 -24
  276. package/docs/functions/hfTokenize.md +0 -27
  277. package/docs/functions/interpolateEnv.md +0 -29
  278. package/docs/functions/interpolateFString.md +0 -29
  279. package/docs/functions/interpolateGolangTemplate.md +0 -35
  280. package/docs/functions/parseFString.md +0 -26
  281. package/docs/functions/reControlCharsRegex.md +0 -19
  282. package/docs/interfaces/DotenvExpandOptions.md +0 -43
  283. package/docs/interfaces/DotenvExpandOutput.md +0 -25
  284. package/docs/interfaces/DotenvParseInput.md +0 -13
  285. package/docs/interfaces/DotenvParseOutput.md +0 -13
  286. package/docs/interfaces/DotenvPopulateInput.md +0 -13
  287. package/docs/type-aliases/FStringPromptTemplateNode.md +0 -14
  288. package/docs/type-aliases/PromptTemplateType.md +0 -11
  289. package/docs/type-aliases/PromptType.md +0 -11
  290. package/docs/variables/HFBuiltins.md +0 -122
  291. package/docs/variables/PromptTemplateTypes.md +0 -11
  292. package/docs/variables/PromptTypes.md +0 -14
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isQuoted**(`s`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:195](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L195)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:195](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L195)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isRegExp**(`value`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/isRegExp.ts#L3)
11
+ Defined in: [packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/isRegExp.ts#L3)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSameString**(`str1`, `str2`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/is-same-string.ts:13](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/is-same-string.ts#L13)
11
+ Defined in: [packages/ai-tool/src/utils/is-same-string.ts:13](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/is-same-string.ts#L13)
12
12
 
13
13
  Compares two strings to check if they are the same.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSectionString**(`text`, `options`?): `null` \| `RegExpExecArray`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L197)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L197)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSentenceEnding**(`text`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L187)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L187)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSepLineString**(`text`): `null` \| `RegExpExecArray`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L227)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L227)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isStrWrapped**(`s`, `pairs`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:200](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L200)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:200](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L200)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isSubdirectory**(`parentDir`, `childDir`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:17](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/has-directory-in.ts#L17)
11
+ Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:17](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/has-directory-in.ts#L17)
12
12
 
13
13
  Determines whether the `childDir` is a subdirectory of `parentDir`.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isTitleString**(`text`, `options`?): `null` \| `RegExpExecArray`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:204](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L204)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:204](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L204)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isValidFilename**(`filename`): `boolean` \| `""`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/filename.ts:63](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/filename.ts#L63)
11
+ Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:373
12
12
 
13
13
  Validates if a given string is a valid filename.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isValidFilepath**(`filepath`): `boolean`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/filename.ts:72](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/filename.ts#L72)
11
+ Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:379
12
12
 
13
13
  Validates whether the given filepath is valid.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **isWebStream**(`val`): val is ReadableStream\<any\> \| WritableStream\<any\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/stream/is-web-stream.ts:1](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/stream/is-web-stream.ts#L1)
11
+ Defined in: [packages/ai-tool/src/utils/stream/is-web-stream.ts:1](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/is-web-stream.ts#L1)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **jsonFilterToWhere**(`filter`, `wrapKey`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/json-filter.ts:123](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/json-filter.ts#L123)
11
+ Defined in: [packages/ai-tool/src/utils/json-filter.ts:123](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/json-filter.ts#L123)
12
12
 
13
13
  Converts a filter object to a SQLite WHERE clause.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **jsonToMarkdownStr**(`mem`, `options`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/json-to-markdown-str.ts:2](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/json-to-markdown-str.ts#L2)
11
+ Defined in: [packages/ai-tool/src/utils/json-to-markdown-str.ts:2](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/json-to-markdown-str.ts#L2)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **loadAIConfig**(`config`): `any`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/load-config.ts:53](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/load-config.ts#L53)
11
+ Defined in: [packages/ai-tool/src/utils/load-config.ts:53](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/load-config.ts#L53)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **loadConfig**(`filename`, `config`): `any`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/load-config.ts:27](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/load-config.ts#L27)
11
+ Defined in: [packages/ai-tool/src/utils/load-config.ts:27](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/load-config.ts#L27)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **loadConfigFile**(`filename`, `searchPaths`): `any`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/load-config.ts:9](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/load-config.ts#L9)
11
+ Defined in: [packages/ai-tool/src/utils/load-config.ts:9](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/load-config.ts#L9)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **loadFileFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?): `Buffer`\<`ArrayBufferLike`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:44](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/load-file-from-paths.ts#L44)
11
+ Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:44](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/load-file-from-paths.ts#L44)
12
12
 
13
13
  Loads a file from given paths, optionally searching for specific extensions.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **loadTextFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?, `exclude`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:101](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/load-file-from-paths.ts#L101)
11
+ Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:101](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/load-file-from-paths.ts#L101)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **\_lrucache**(`this`, `__namedParameters`): `Cache`
10
10
 
11
- Defined in: [packages/ai-tool/src/funcs/lrucache.ts:8](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/lrucache.ts#L8)
11
+ Defined in: [packages/ai-tool/src/funcs/lrucache.ts:8](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/funcs/lrucache.ts#L8)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **makeToolFuncCancelable**\<`T`\>(`targetClass`?, `options`?): `EnhancedClass`\<`T`, *typeof* [`CancelableAbility`](../classes/CancelableAbility.md)\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:382](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/cancelable-ability.ts#L382)
11
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:382](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/cancelable-ability.ts#L382)
12
12
 
13
13
  ## Type Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **matchUrlProtocol**(`name`): `undefined` \| `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/match-url-protocol.ts:23](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/match-url-protocol.ts#L23)
11
+ Defined in: [packages/ai-tool/src/utils/match-url-protocol.ts:23](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/match-url-protocol.ts#L23)
12
12
 
13
13
  Extracts the protocol part from a URL-like string.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **memoize**\<`F`\>(`fn`, `options`?): `F` & `Memoized`\<`F`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/memoize.ts:14](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/memoize.ts#L14)
11
+ Defined in: [packages/ai-tool/src/utils/memoize.ts:14](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/memoize.ts#L14)
12
12
 
13
13
  ## Type Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **messagesToText**(`messages`): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/chat.ts:157](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/chat.ts#L157)
11
+ Defined in: [packages/ai-tool/src/utils/chat.ts:157](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L157)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **paramsSizeToScaleStr**(`paramsSize`, `fractionDigits`): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/convert-params-size.ts:11](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/convert-params-size.ts#L11)
11
+ Defined in: [packages/ai-tool/src/utils/convert-params-size.ts:11](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/convert-params-size.ts#L11)
12
12
 
13
13
  Formats a parameter size in bytes into a string with an appropriate scale (T, B, M, or K),
14
14
  optionally specifying the number of fractional digits to display.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseCommand**(`commandStr`, `scope`?, `options`?): `Promise`\<`undefined` \| \{ `args`: `Record`\<`string`, `any`\>; `command`: `string`; \}\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:446](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L446)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:446](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L446)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseJsJson**(`input`, `scope`?): `Promise`\<`any`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-js-json.ts:16](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-js-json.ts#L16)
11
+ Defined in: [packages/ai-tool/src/utils/parse-js-json.ts:16](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-js-json.ts#L16)
12
12
 
13
13
  Parses a JavaScript string into a JSON object.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseJsJsonSimpleSync**(`input`, `scope`?): `any`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-js-json.ts:28](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-js-json.ts#L28)
11
+ Defined in: [packages/ai-tool/src/utils/parse-js-json.ts:28](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-js-json.ts#L28)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseObjectArgInfo**(`argInfo`, `ix`, `scope`?, `options`?): `Promise`\<`string`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:304](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L304)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:304](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L304)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseObjectArgumentInfos**(`args`, `scope`?, `options`?): `Promise`\<`any`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:138](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L138)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:138](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L138)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseObjectArguments**(`argsStr`, `scope`?, `options`?): `Promise`\<`any`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:71](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L71)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:71](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L71)
12
12
 
13
13
  Asynchronously parses a string of object arguments into an actual object.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseObjectArgumentsAsArgInfos**(`argsStr`, `scope`?, `options`?): `ArgInfo`[]
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:353](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L353)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:353](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L353)
12
12
 
13
13
  Parses an object arguments string into an array of ArgInfo.
14
14
 
@@ -8,7 +8,9 @@
8
8
 
9
9
  > **parseYaml**(`content`, `options`?): `any`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/config.ts:26](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/config.ts#L26)
11
+ Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:271
12
+
13
+ Parses a YAML string into a JavaScript object with optional custom tags.
12
14
 
13
15
  ## Parameters
14
16
 
@@ -16,10 +18,28 @@ Defined in: [packages/ai-tool/src/utils/config.ts:26](https://github.com/isdk/ai
16
18
 
17
19
  `string`
18
20
 
21
+ The YAML string to parse.
22
+
19
23
  ### options?
20
24
 
21
25
  `ParseOptions` & `DocumentOptions` & `SchemaOptions` & `ToJSOptions`
22
26
 
27
+ Optional parsing options, including custom tags.
28
+
23
29
  ## Returns
24
30
 
25
31
  `any`
32
+
33
+ The parsed JavaScript object.
34
+
35
+ ## Example
36
+
37
+ ```typescript
38
+ import { parseYaml } from './yaml';
39
+
40
+ const yamlContent = `
41
+ example: !custom value
42
+ `;
43
+ const result = parseYaml(yamlContent);
44
+ console.log(result); // { example: 'resolved-value' }
45
+ ```
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **quoteStr**(`str`): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:252](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L252)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:252](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L252)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **readFilenamesRecursiveSync**(`dir`, `options`?): `string`[]
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:136](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/load-file-from-paths.ts#L136)
11
+ Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:137](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/load-file-from-paths.ts#L137)
12
12
 
13
13
  Recursively reads all filenames in the given directory or directories.
14
14
  Optionally filters the results using a file matching callback.
@@ -33,6 +33,12 @@ An optional callback that determines whether a file should be included in the re
33
33
 
34
34
  `number`
35
35
 
36
+ #### resolveSymlinks?
37
+
38
+ `boolean`
39
+
40
+ Whether to resolve symbolic links to their real paths. Defaults to true.
41
+
36
42
  #### signal?
37
43
 
38
44
  `AbortSignal`
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **readTextFileChunks**(`filePath`, `options`?): `AsyncIterable`\<`string`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:41](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/read-text-file-chunks.ts#L41)
11
+ Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:41](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/read-text-file-chunks.ts#L41)
12
12
 
13
13
  Reads a text file and yields chunks of text that are within a specified token limit.
14
14
  This function supports both small files that can be read entirely into memory,
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **readTextFileChunksEx**(`filePath`, `options`?): `AsyncIterable`\<`string`[]\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:109](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/read-text-file-chunks.ts#L109)
11
+ Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:109](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/read-text-file-chunks.ts#L109)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **readableFromAsyncIterable**\<`T`\>(`iterable`): `ReadableStream`\<`T`\>
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:164](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/stream/ai-stream.ts#L164)
11
+ Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:164](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/ai-stream.ts#L164)
12
12
 
13
13
  Implements ReadableStream.from(asyncIterable), which isn't documented in MDN and isn't implemented in node.
14
14
  https://github.com/whatwg/streams/commit/8d7a0bf26eb2cc23e884ddbaac7c1da4b91cf2bc
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **registerCoreTools**(): `void`
10
10
 
11
- Defined in: [packages/ai-tool/src/funcs/index.ts:9](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/index.ts#L9)
11
+ Defined in: [packages/ai-tool/src/funcs/index.ts:9](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/funcs/index.ts#L9)
12
12
 
13
13
  ## Returns
14
14
 
@@ -8,14 +8,30 @@
8
8
 
9
9
  > **registerYamlTag**(`tags`): `void`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/config.ts:16](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/config.ts#L16)
11
+ Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:252
12
+
13
+ Registers custom YAML tags to be used in parsing and stringifying YAML content.
12
14
 
13
15
  ## Parameters
14
16
 
15
17
  ### tags
16
18
 
17
- `any`
19
+ A single tag or an array of tags to register.
20
+
21
+ `"map"` | `"binary"` | `"null"` | `ScalarTag` | `CollectionTag` | `"bool"` | `"float"` | `"floatExp"` | `"floatNaN"` | `"floatTime"` | `"int"` | `"intHex"` | `"intOct"` | `"intTime"` | `"merge"` | `"omap"` | `"pairs"` | `"seq"` | `"set"` | `"timestamp"` | `Tags`
18
22
 
19
23
  ## Returns
20
24
 
21
25
  `void`
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import { registerYamlTag } from './yaml';
31
+
32
+ const customTag = {
33
+ tag: '!custom',
34
+ resolve: (value) => `resolved-${value}`,
35
+ };
36
+ registerYamlTag(customTag);
37
+ ```
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **removeMarkdownBold**(`s`, `once`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:292](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L292)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:292](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L292)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **removeMarkdownBoldAndItalic**(`s`, `once`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:312](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L312)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:312](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L312)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **removeMarkdownItalic**(`s`, `once`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/split-sentence.ts:302](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/split-sentence.ts#L302)
11
+ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:302](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/split-sentence.ts#L302)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **replaceWithPlaceholder**(`content`, `options`?): \[`string`, `string`[]\]
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:487](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L487)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:487](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L487)
12
12
 
13
13
  Replaces substrings in the given content with placeholders.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **restoreFromPlacehoders**(`content`, `placehoders`, `options`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:540](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/parse-command.ts#L540)
11
+ Defined in: [packages/ai-tool/src/utils/parse-command.ts:540](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L540)
12
12
 
13
13
  Restores the original substrings from placeholders in the given content.
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: sanitizeFilename()
8
8
 
9
- > **sanitizeFilename**(`filename`, `options`): `string`
9
+ > **sanitizeFilename**(`filename`, `options`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/filename.ts:97](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/filename.ts#L97)
11
+ Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:393
12
12
 
13
13
  Sanitizes a given filename by replacing invalid characters with a specified replacement character or a default.
14
14
 
@@ -20,9 +20,9 @@ Sanitizes a given filename by replacing invalid characters with a specified repl
20
20
 
21
21
  The filename to sanitize, represented as a string.
22
22
 
23
- ### options
23
+ ### options?
24
24
 
25
- [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
25
+ [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md)
26
26
 
27
27
  An optional object containing configuration options:
28
28
  - `replacement` {string} - The character to replace invalid characters with. Default is '!'. Cannot contain reserved filename characters.
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: sanitizeFilepath()
8
8
 
9
- > **sanitizeFilepath**(`filepath`, `options`): `string`
9
+ > **sanitizeFilepath**(`filepath`, `options`?): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/filename.ts:149](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/filename.ts#L149)
11
+ Defined in: node\_modules/.pnpm/@isdk+util@0.3.0/node\_modules/@isdk/util/dist/index.d.ts:400
12
12
 
13
13
  Sanitizes each part of a file path and reassembles it, ensuring the path is valid according to provided options.
14
14
 
@@ -20,9 +20,9 @@ Sanitizes each part of a file path and reassembles it, ensuring the path is vali
20
20
 
21
21
  The file path to sanitize, represented as a string.
22
22
 
23
- ### options
23
+ ### options?
24
24
 
25
- [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md) = `{}`
25
+ [`SanitizeFilenameOptions`](../interfaces/SanitizeFilenameOptions.md)
26
26
 
27
27
  Optional settings for sanitization, extending `SanitizeFilenameOptions`. Allows customization of replacement characters and maximum filename length.
28
28
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **saveConfigFile**(`filename`, `config`, `extLevel`): `string`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/config.ts:114](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/config.ts#L114)
11
+ Defined in: [packages/ai-tool/src/utils/config.ts:46](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/config.ts#L46)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **scaleStrToParamsSize**(`scale`): `number`
10
10
 
11
- Defined in: [packages/ai-tool/src/utils/convert-params-size.ts:44](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/convert-params-size.ts#L44)
11
+ Defined in: [packages/ai-tool/src/utils/convert-params-size.ts:44](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/convert-params-size.ts#L44)
12
12
 
13
13
  Converts a formatted parameters size string (with units T, B, M, or K) back to its byte value.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **shutdown**(`signalOrEvent`, `exitCode`): `Promise`\<`undefined`\>
10
10
 
11
- 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)
11
+ Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:64](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/node/before-shutdown.ts#L64)
12
12
 
13
13
  Main process shutdown handler. Will invoke every previously registered async shutdown listener
14
14
  in the queue and exit with a code of `0`. Any `Promise` rejections from any listener will