@isdk/ai-tool 0.3.0 → 0.5.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 (296) hide show
  1. package/dist/chunk-VIG2GB47.mjs +39 -1
  2. package/dist/chunk-VJ45JQBR.mjs +7829 -0
  3. package/dist/funcs.d.mts +3 -2
  4. package/dist/funcs.d.ts +3 -2
  5. package/dist/funcs.js +5156 -1
  6. package/dist/funcs.mjs +29 -1
  7. package/dist/index-Br-4ZYgE.d.mts +892 -0
  8. package/dist/index-Br-4ZYgE.d.ts +892 -0
  9. package/dist/index.d.mts +206 -238
  10. package/dist/index.d.ts +206 -238
  11. package/dist/index.js +8132 -1
  12. package/dist/index.mjs +476 -1
  13. package/dist/test/util.js +101 -1
  14. package/dist/test/util.mjs +30 -1
  15. package/package.json +31 -31
  16. package/dist/chunk-JHHFTTVE.mjs +0 -1
  17. package/dist/index-BC3GQn6-.d.mts +0 -488
  18. package/dist/index-BC3GQn6-.d.ts +0 -488
  19. package/docs/README.md +0 -250
  20. package/docs/_media/CONTRIBUTING.md +0 -18
  21. package/docs/_media/LICENSE-MIT +0 -22
  22. package/docs/classes/AbortError.md +0 -368
  23. package/docs/classes/AlreadyExistsError.md +0 -348
  24. package/docs/classes/BaseError.md +0 -359
  25. package/docs/classes/CancelableAbility.md +0 -379
  26. package/docs/classes/ClientTools.md +0 -2691
  27. package/docs/classes/CommonError.md +0 -377
  28. package/docs/classes/ConfigFile.md +0 -333
  29. package/docs/classes/EventClient.md +0 -3119
  30. package/docs/classes/EventServer.md +0 -3149
  31. package/docs/classes/EventToolFunc.md +0 -2533
  32. package/docs/classes/FStringPromptTemplate.md +0 -1150
  33. package/docs/classes/FewShotPromptTemplate.md +0 -1186
  34. package/docs/classes/GolangPromptTemplate.md +0 -1150
  35. package/docs/classes/HFEnvironment.md +0 -186
  36. package/docs/classes/HFInterpreter.md +0 -75
  37. package/docs/classes/HFTemplate.md +0 -67
  38. package/docs/classes/HfPromptTemplate.md +0 -1150
  39. package/docs/classes/IntSet.md +0 -216
  40. package/docs/classes/NotFoundError.md +0 -348
  41. package/docs/classes/NotImplementationError.md +0 -348
  42. package/docs/classes/PromptExampleSelector.md +0 -195
  43. package/docs/classes/PromptTemplate.md +0 -1079
  44. package/docs/classes/ReadableStreamError.md +0 -368
  45. package/docs/classes/ResClientTools.md +0 -2399
  46. package/docs/classes/ResServerTools.md +0 -2385
  47. package/docs/classes/SSEChannel.md +0 -270
  48. package/docs/classes/Semaphore.md +0 -177
  49. package/docs/classes/ServerTools.md +0 -2609
  50. package/docs/classes/TaskAbortController.md +0 -137
  51. package/docs/classes/ToolFunc.md +0 -2147
  52. package/docs/classes/YamlTypeBaseObject.md +0 -29
  53. package/docs/enumerations/AsyncFeatureBits.md +0 -37
  54. package/docs/enumerations/AsyncFeatures.md +0 -37
  55. package/docs/enumerations/ErrorCode.md +0 -217
  56. package/docs/enumerations/HashAlgorithm.md +0 -117
  57. package/docs/functions/AIArgProcessor.md +0 -27
  58. package/docs/functions/AIStream.md +0 -50
  59. package/docs/functions/ChoiceArgProcessor.md +0 -27
  60. package/docs/functions/RateLimit.md +0 -33
  61. package/docs/functions/TemplateArgProcessor.md +0 -27
  62. package/docs/functions/backendEventable.md +0 -23
  63. package/docs/functions/canonicalize.md +0 -21
  64. package/docs/functions/completeSentences.md +0 -23
  65. package/docs/functions/concatText.md +0 -23
  66. package/docs/functions/countLLMTokens.md +0 -23
  67. package/docs/functions/countRegexMatches.md +0 -33
  68. package/docs/functions/createAbilityInjector.md +0 -87
  69. package/docs/functions/createCallbacksTransformer.md +0 -49
  70. package/docs/functions/createEmptyReadableStream.md +0 -23
  71. package/docs/functions/createEndWithRepetitionDetector.md +0 -29
  72. package/docs/functions/createError.md +0 -35
  73. package/docs/functions/createEventStreamTransformer.md +0 -33
  74. package/docs/functions/createHfValueFunc.md +0 -29
  75. package/docs/functions/createLRUCache.md +0 -23
  76. package/docs/functions/createYamlObjectTag.md +0 -23
  77. package/docs/functions/dateToText.md +0 -23
  78. package/docs/functions/decodeCharset.md +0 -23
  79. package/docs/functions/detectCharset.md +0 -23
  80. package/docs/functions/encodeLLMTokens.md +0 -23
  81. package/docs/functions/expandEnv.md +0 -40
  82. package/docs/functions/expandObjEnv.md +0 -54
  83. package/docs/functions/extNameLevel.md +0 -43
  84. package/docs/functions/fileIsExists.md +0 -34
  85. package/docs/functions/filenameReservedRegex.md +0 -22
  86. package/docs/functions/filterValidFnScope.md +0 -21
  87. package/docs/functions/findIndexNonEmptyFrom.md +0 -23
  88. package/docs/functions/findPort.md +0 -23
  89. package/docs/functions/formatISO.md +0 -71
  90. package/docs/functions/formatTextWithSpace.md +0 -59
  91. package/docs/functions/getAllEnumKeys.md +0 -31
  92. package/docs/functions/getConfigFileNames.md +0 -23
  93. package/docs/functions/getConfigs.md +0 -23
  94. package/docs/functions/getFileMetaInfo.md +0 -21
  95. package/docs/functions/getHashAlgoBySize.md +0 -21
  96. package/docs/functions/getKeysPath.md +0 -38
  97. package/docs/functions/getLLMTokenizer.md +0 -21
  98. package/docs/functions/getMultiLevelExtname.md +0 -31
  99. package/docs/functions/getPackageDir.md +0 -39
  100. package/docs/functions/getRealFilepath.md +0 -34
  101. package/docs/functions/getResponseErrorReadableStream.md +0 -21
  102. package/docs/functions/hasDirectoryIn.md +0 -38
  103. package/docs/functions/hashFile.md +0 -23
  104. package/docs/functions/hashStream.md +0 -23
  105. package/docs/functions/hfParse.md +0 -24
  106. package/docs/functions/hfTokenize.md +0 -25
  107. package/docs/functions/interpolateEnv.md +0 -25
  108. package/docs/functions/interpolateFString.md +0 -27
  109. package/docs/functions/interpolateGolangTemplate.md +0 -31
  110. package/docs/functions/isLangUsingSpaces.md +0 -21
  111. package/docs/functions/isListItemString.md +0 -21
  112. package/docs/functions/isModelNameMatched.md +0 -45
  113. package/docs/functions/isPunctuationChar.md +0 -36
  114. package/docs/functions/isRegExp.md +0 -21
  115. package/docs/functions/isSectionString.md +0 -23
  116. package/docs/functions/isSentenceEnding.md +0 -21
  117. package/docs/functions/isSepLineString.md +0 -21
  118. package/docs/functions/isSubdirectory.md +0 -39
  119. package/docs/functions/isTitleString.md +0 -23
  120. package/docs/functions/isValidFilename.md +0 -38
  121. package/docs/functions/isValidFilepath.md +0 -27
  122. package/docs/functions/isWebStream.md +0 -21
  123. package/docs/functions/jsonFilterToWhere.md +0 -45
  124. package/docs/functions/jsonToMarkdownStr.md +0 -31
  125. package/docs/functions/loadFileFromPaths.md +0 -54
  126. package/docs/functions/loadTextFromPaths.md +0 -29
  127. package/docs/functions/lrucache.md +0 -29
  128. package/docs/functions/makeToolFuncCancelable.md +0 -23
  129. package/docs/functions/matchUrlProtocol.md +0 -48
  130. package/docs/functions/memoize.md +0 -27
  131. package/docs/functions/messagesToText.md +0 -21
  132. package/docs/functions/paramsSizeToScaleStr.md +0 -32
  133. package/docs/functions/parseCommand.md +0 -33
  134. package/docs/functions/parseDateFormat.md +0 -360
  135. package/docs/functions/parseFString.md +0 -26
  136. package/docs/functions/parseISO.md +0 -72
  137. package/docs/functions/parseJsJson.md +0 -38
  138. package/docs/functions/parseJsJsonSimpleSync.md +0 -23
  139. package/docs/functions/parseObjectArgInfo.md +0 -27
  140. package/docs/functions/parseObjectArgumentInfos.md +0 -25
  141. package/docs/functions/parseObjectArguments.md +0 -68
  142. package/docs/functions/parseObjectArgumentsAsArgInfos.md +0 -42
  143. package/docs/functions/parseYaml.md +0 -21
  144. package/docs/functions/quoteStr.md +0 -21
  145. package/docs/functions/reControlCharsRegex.md +0 -21
  146. package/docs/functions/readFilenamesRecursiveSync.md +0 -47
  147. package/docs/functions/readTextFileChunks.md +0 -51
  148. package/docs/functions/readTextFileChunksEx.md +0 -23
  149. package/docs/functions/readableFromAsyncIterable.md +0 -28
  150. package/docs/functions/registerCoreTools.md +0 -17
  151. package/docs/functions/registerYamlTag.md +0 -21
  152. package/docs/functions/removeMarkdownBold.md +0 -23
  153. package/docs/functions/removeMarkdownBoldAndItalic.md +0 -23
  154. package/docs/functions/removeMarkdownItalic.md +0 -23
  155. package/docs/functions/replaceWithPlaceholder.md +0 -41
  156. package/docs/functions/restoreFromPlacehoders.md +0 -45
  157. package/docs/functions/sanitizeFilename.md +0 -37
  158. package/docs/functions/sanitizeFilepath.md +0 -31
  159. package/docs/functions/saveConfigFile.md +0 -25
  160. package/docs/functions/scaleStrToParamsSize.md +0 -27
  161. package/docs/functions/simplifyObjectArguments.md +0 -21
  162. package/docs/functions/sortedValues.md +0 -25
  163. package/docs/functions/splitChunks.md +0 -23
  164. package/docs/functions/splitParagraph.md +0 -32
  165. package/docs/functions/splitSentence.md +0 -37
  166. package/docs/functions/stringifyYaml.md +0 -21
  167. package/docs/functions/stripConsoleColor.md +0 -21
  168. package/docs/functions/textToDate.md +0 -23
  169. package/docs/functions/throwError.md +0 -37
  170. package/docs/functions/toDate.md +0 -76
  171. package/docs/functions/toDateTime.md +0 -21
  172. package/docs/functions/toRegExp.md +0 -34
  173. package/docs/functions/trimStartOfStreamHelper.md +0 -41
  174. package/docs/functions/truncTo.md +0 -47
  175. package/docs/functions/truncateByToken.md +0 -23
  176. package/docs/functions/truncateToTokenLimit.md +0 -44
  177. package/docs/functions/truncateToTokenLimitEx.md +0 -23
  178. package/docs/functions/uuid.md +0 -23
  179. package/docs/functions/uuidParse.md +0 -21
  180. package/docs/functions/uuidStringify.md +0 -23
  181. package/docs/functions/uuidValidate.md +0 -21
  182. package/docs/functions/uuidVersion.md +0 -21
  183. package/docs/functions/uuidv1.md +0 -47
  184. package/docs/functions/uuidv4.md +0 -47
  185. package/docs/functions/uuidv5.md +0 -51
  186. package/docs/functions/wait.md +0 -21
  187. package/docs/functions/xxhash.md +0 -25
  188. package/docs/functions/xxhash32.md +0 -23
  189. package/docs/functions/xxhash64.md +0 -23
  190. package/docs/functions/xxhashAsStr.md +0 -25
  191. package/docs/globals.md +0 -285
  192. package/docs/interfaces/AIChatAssistantMessageParam.md +0 -117
  193. package/docs/interfaces/AIChatContentPartImage.md +0 -31
  194. package/docs/interfaces/AIChatContentPartText.md +0 -27
  195. package/docs/interfaces/AIChatMessageParamBase.md +0 -58
  196. package/docs/interfaces/AIChatMessageToolCall.md +0 -45
  197. package/docs/interfaces/AIChatSystemMessageParam.md +0 -87
  198. package/docs/interfaces/AIChatToolMessageParam.md +0 -97
  199. package/docs/interfaces/AIChatUserMessageParam.md +0 -127
  200. package/docs/interfaces/AIChoiceConfig.md +0 -77
  201. package/docs/interfaces/AIResult.md +0 -73
  202. package/docs/interfaces/AIStreamParser.md +0 -39
  203. package/docs/interfaces/AIStreamParserOptions.md +0 -21
  204. package/docs/interfaces/BaseFunc.md +0 -155
  205. package/docs/interfaces/BaseFuncItem.md +0 -103
  206. package/docs/interfaces/CancelableAbilityOptions.md +0 -115
  207. package/docs/interfaces/ClientFuncItem.md +0 -179
  208. package/docs/interfaces/DotenvExpandOptions.md +0 -47
  209. package/docs/interfaces/DotenvExpandOutput.md +0 -27
  210. package/docs/interfaces/DotenvParseInput.md +0 -11
  211. package/docs/interfaces/DotenvParseOutput.md +0 -11
  212. package/docs/interfaces/DotenvPopulateInput.md +0 -11
  213. package/docs/interfaces/EventClientFuncParams.md +0 -55
  214. package/docs/interfaces/EventServerFuncParams.md +0 -71
  215. package/docs/interfaces/FewShotPromptTemplateOptions.md +0 -163
  216. package/docs/interfaces/FuncItem.md +0 -143
  217. package/docs/interfaces/FuncParam.md +0 -71
  218. package/docs/interfaces/FuncParams.md +0 -11
  219. package/docs/interfaces/Funcs.md +0 -11
  220. package/docs/interfaces/HashAlgoParams.md +0 -37
  221. package/docs/interfaces/IFileMetaInfo.md +0 -77
  222. package/docs/interfaces/IReadTextFileChunksOptions.md +0 -157
  223. package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -111
  224. package/docs/interfaces/JsonFilter.md +0 -11
  225. package/docs/interfaces/ParseObjectArgumentOptions.md +0 -97
  226. package/docs/interfaces/PromptExampleSelectorOptions.md +0 -36
  227. package/docs/interfaces/PromptTemplateOptions.md +0 -75
  228. package/docs/interfaces/RemoteFuncItem.md +0 -168
  229. package/docs/interfaces/ReplacePlacehoderOptions.md +0 -47
  230. package/docs/interfaces/ResClientFuncParams.md +0 -35
  231. package/docs/interfaces/ResServerFuncParams.md +0 -73
  232. package/docs/interfaces/SanitizeFilenameOptions.md +0 -27
  233. package/docs/interfaces/SectionStringOptions.md +0 -27
  234. package/docs/interfaces/ServerFuncItem.md +0 -189
  235. package/docs/interfaces/ServerFuncParams.md +0 -37
  236. package/docs/interfaces/SplitSentenceOptions.md +0 -47
  237. package/docs/interfaces/StreamCallbacksAndOptions.md +0 -95
  238. package/docs/interfaces/TaskAbortControllers.md +0 -11
  239. package/docs/interfaces/TaskPromise.md +0 -138
  240. package/docs/interfaces/ToolFuncPackage.md +0 -49
  241. package/docs/type-aliases/AIChatContentPart.md +0 -13
  242. package/docs/type-aliases/AIChatMessageParam.md +0 -13
  243. package/docs/type-aliases/AIChatRole.md +0 -13
  244. package/docs/type-aliases/AIMessageType.md +0 -13
  245. package/docs/type-aliases/AIModelNameRule.md +0 -13
  246. package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
  247. package/docs/type-aliases/AIModelNameRules.md +0 -13
  248. package/docs/type-aliases/AITextGenerationFinishReason.md +0 -13
  249. package/docs/type-aliases/ActionName.md +0 -13
  250. package/docs/type-aliases/AsyncTaskId.md +0 -13
  251. package/docs/type-aliases/EventErrorListenerFn.md +0 -27
  252. package/docs/type-aliases/EventListenerFn.md +0 -25
  253. package/docs/type-aliases/FStringPromptTemplateNode.md +0 -16
  254. package/docs/type-aliases/FuncParamType.md +0 -13
  255. package/docs/type-aliases/PromptExamples.md +0 -17
  256. package/docs/type-aliases/PromptTemplateType.md +0 -13
  257. package/docs/type-aliases/PromptType.md +0 -13
  258. package/docs/type-aliases/TFunc.md +0 -23
  259. package/docs/variables/AIChatRoles.md +0 -13
  260. package/docs/variables/AIMessageTypes.md +0 -13
  261. package/docs/variables/AITextGenerationFinishReasons.md +0 -13
  262. package/docs/variables/AbortErrorCode.md +0 -13
  263. package/docs/variables/ActionNames.md +0 -13
  264. package/docs/variables/AlreadyExistsErrorCode.md +0 -13
  265. package/docs/variables/ClientToolFuncSchema.md +0 -87
  266. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +0 -13
  267. package/docs/variables/EventBusName.md +0 -13
  268. package/docs/variables/EventName.md +0 -13
  269. package/docs/variables/FilenameReservedRegex.md +0 -16
  270. package/docs/variables/HFBuiltins.md +0 -92
  271. package/docs/variables/InternalErrorCode.md +0 -13
  272. package/docs/variables/LLM_TOKENIZER_NAMES.md +0 -83
  273. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +0 -13
  274. package/docs/variables/NotFoundErrorCode.md +0 -13
  275. package/docs/variables/NotImplementedErrorCode.md +0 -13
  276. package/docs/variables/PASSING_SCORE.md +0 -13
  277. package/docs/variables/PromptTemplateTypes.md +0 -13
  278. package/docs/variables/PromptTypes.md +0 -16
  279. package/docs/variables/RStreamErrCode.md +0 -13
  280. package/docs/variables/RemoteToolFuncSchema.md +0 -87
  281. package/docs/variables/ResponseRStreamErrCode.md +0 -13
  282. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +0 -13
  283. package/docs/variables/ServerToolFuncSchema.md +0 -87
  284. package/docs/variables/ToolAsyncCancelableBit.md +0 -13
  285. package/docs/variables/ToolAsyncMultiTaskBit.md +0 -13
  286. package/docs/variables/ToolAsyncPriorityBit.md +0 -13
  287. package/docs/variables/ToolFuncSchema.md +0 -125
  288. package/docs/variables/WindowsReservedNameRegex.md +0 -15
  289. package/docs/variables/base32768.md +0 -13
  290. package/docs/variables/defaultTemplateFormat.md +0 -13
  291. package/docs/variables/event.md +0 -13
  292. package/docs/variables/eventClient.md +0 -13
  293. package/docs/variables/eventServer.md +0 -13
  294. package/docs/variables/lrucache.md +0 -13
  295. package/docs/variables/mimeType.md +0 -13
  296. package/docs/variables/uuidNIL.md +0 -13
package/docs/interfaces/RemoteFuncItem.md DELETED
@@ -1,168 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / RemoteFuncItem
6
-
7
- # Interface: RemoteFuncItem
8
-
9
- ## Extends
10
-
11
- - [`BaseFuncItem`](BaseFuncItem.md)
12
-
13
- ## Extended by
14
-
15
- - [`ClientFuncItem`](ClientFuncItem.md)
16
- - [`ServerFuncItem`](ServerFuncItem.md)
17
-
18
- ## Properties
19
-
20
- ### action?
21
-
22
- > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
23
-
24
- #### Defined in
25
-
26
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L35)
27
-
28
- ***
29
-
30
- ### apiRoot?
31
-
32
- > `optional` **apiRoot**: `string`
33
-
34
- #### Defined in
35
-
36
- [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L34)
37
-
38
- ***
39
-
40
- ### fetchOptions?
41
-
42
- > `optional` **fetchOptions**: `any`
43
-
44
- #### Defined in
45
-
46
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L36)
47
-
48
- ***
49
-
50
- ### isApi?
51
-
52
- > `optional` **isApi**: `boolean`
53
-
54
- #### Inherited from
55
-
56
- [`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
57
-
58
- #### Defined in
59
-
60
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L47)
61
-
62
- ***
63
-
64
- ### name?
65
-
66
- > `optional` **name**: `string`
67
-
68
- #### Inherited from
69
-
70
- [`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
71
-
72
- #### Defined in
73
-
74
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L41)
75
-
76
- ***
77
-
78
- ### params?
79
-
80
- > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
81
-
82
- #### Inherited from
83
-
84
- [`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
85
-
86
- #### Defined in
87
-
88
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L42)
89
-
90
- ***
91
-
92
- ### result?
93
-
94
- > `optional` **result**: `string`
95
-
96
- #### Inherited from
97
-
98
- [`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
99
-
100
- #### Defined in
101
-
102
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L43)
103
-
104
- ***
105
-
106
- ### scope?
107
-
108
- > `optional` **scope**: `any`
109
-
110
- #### Inherited from
111
-
112
- [`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
113
-
114
- #### Defined in
115
-
116
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L44)
117
-
118
- ***
119
-
120
- ### setup()?
121
-
122
- > `optional` **setup**: (`this`, `options`?) => `void`
123
-
124
- #### Parameters
125
-
126
- • **this**: [`ToolFunc`](../classes/ToolFunc.md)
127
-
128
- • **options?**: [`FuncItem`](FuncItem.md)
129
-
130
- #### Returns
131
-
132
- `void`
133
-
134
- #### Inherited from
135
-
136
- [`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
137
-
138
- #### Defined in
139
-
140
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L46)
141
-
142
- ***
143
-
144
- ### stream?
145
-
146
- > `optional` **stream**: `boolean`
147
-
148
- #### Inherited from
149
-
150
- [`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
151
-
152
- #### Defined in
153
-
154
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L48)
155
-
156
- ***
157
-
158
- ### tags?
159
-
160
- > `optional` **tags**: `string` \| `string`[]
161
-
162
- #### Inherited from
163
-
164
- [`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
165
-
166
- #### Defined in
167
-
168
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L45)
package/docs/interfaces/ReplacePlacehoderOptions.md DELETED
@@ -1,47 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ReplacePlacehoderOptions
6
-
7
- # Interface: ReplacePlacehoderOptions
8
-
9
- ## Properties
10
-
11
- ### endChar?
12
-
13
- > `optional` **endChar**: `string` \| `string`[]
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/parse-command.ts:415](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L415)
18
-
19
- ***
20
-
21
- ### placehoders?
22
-
23
- > `optional` **placehoders**: `string`[]
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/parse-command.ts:417](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L417)
28
-
29
- ***
30
-
31
- ### placeholder?
32
-
33
- > `optional` **placeholder**: `string`
34
-
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/utils/parse-command.ts:416](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L416)
38
-
39
- ***
40
-
41
- ### startChar?
42
-
43
- > `optional` **startChar**: `string` \| `string`[]
44
-
45
- #### Defined in
46
-
47
- [packages/ai-tool/src/utils/parse-command.ts:414](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L414)
package/docs/interfaces/ResClientFuncParams.md DELETED
@@ -1,35 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ResClientFuncParams
6
-
7
- # Interface: ResClientFuncParams
8
-
9
- ## Extends
10
-
11
- - `RpcMethodsClientFuncParams`
12
-
13
- ## Properties
14
-
15
- ### act?
16
-
17
- > `optional` **act**: `string`
18
-
19
- #### Inherited from
20
-
21
- `RpcMethodsClientFuncParams.act`
22
-
23
- #### Defined in
24
-
25
- [packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/rpc-methods-client-tool.ts#L5)
26
-
27
- ***
28
-
29
- ### id?
30
-
31
- > `optional` **id**: `string` \| `number`
32
-
33
- #### Defined in
34
-
35
- [packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-client-tools.ts#L6)
package/docs/interfaces/ResServerFuncParams.md DELETED
@@ -1,73 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ResServerFuncParams
6
-
7
- # Interface: ResServerFuncParams
8
-
9
- ## Extends
10
-
11
- - `RpcMethodsServerFuncParams`
12
-
13
- ## Properties
14
-
15
- ### \_req?
16
-
17
- > `optional` **\_req**: `IncomingMessage`
18
-
19
- #### Inherited from
20
-
21
- `RpcMethodsServerFuncParams._req`
22
-
23
- #### Defined in
24
-
25
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L9)
26
-
27
- ***
28
-
29
- ### \_res?
30
-
31
- > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
32
-
33
- #### Inherited from
34
-
35
- `RpcMethodsServerFuncParams._res`
36
-
37
- #### Defined in
38
-
39
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L10)
40
-
41
- ***
42
-
43
- ### act?
44
-
45
- > `optional` **act**: `string`
46
-
47
- #### Inherited from
48
-
49
- `RpcMethodsServerFuncParams.act`
50
-
51
- #### Defined in
52
-
53
- [packages/ai-tool/src/rpc-methods-server-tool.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/rpc-methods-server-tool.ts#L7)
54
-
55
- ***
56
-
57
- ### id?
58
-
59
- > `optional` **id**: `string` \| `number`
60
-
61
- #### Defined in
62
-
63
- [packages/ai-tool/src/res-server-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-server-tools.ts#L6)
64
-
65
- ***
66
-
67
- ### val?
68
-
69
- > `optional` **val**: `any`
70
-
71
- #### Defined in
72
-
73
- [packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/res-server-tools.ts#L8)
package/docs/interfaces/SanitizeFilenameOptions.md DELETED
@@ -1,27 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / SanitizeFilenameOptions
6
-
7
- # Interface: SanitizeFilenameOptions
8
-
9
- ## Properties
10
-
11
- ### maxLength?
12
-
13
- > `optional` **maxLength**: `number`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L85)
18
-
19
- ***
20
-
21
- ### replacement?
22
-
23
- > `optional` **replacement**: `string`
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L84)
package/docs/interfaces/SectionStringOptions.md DELETED
@@ -1,27 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / SectionStringOptions
6
-
7
- # Interface: SectionStringOptions
8
-
9
- ## Properties
10
-
11
- ### isMarkdown?
12
-
13
- > `optional` **isMarkdown**: `boolean`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/split-sentence.ts:194](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L194)
18
-
19
- ***
20
-
21
- ### nextLine?
22
-
23
- > `optional` **nextLine**: `string`
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/split-sentence.ts:195](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L195)
package/docs/interfaces/ServerFuncItem.md DELETED
@@ -1,189 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ServerFuncItem
6
-
7
- # Interface: ServerFuncItem
8
-
9
- ## Extends
10
-
11
- - [`RemoteFuncItem`](RemoteFuncItem.md)
12
-
13
- ## Extended by
14
-
15
- - [`ServerTools`](../classes/ServerTools.md)
16
-
17
- ## Properties
18
-
19
- ### action?
20
-
21
- > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
22
-
23
- #### Inherited from
24
-
25
- [`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
26
-
27
- #### Defined in
28
-
29
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L35)
30
-
31
- ***
32
-
33
- ### allowExportFunc?
34
-
35
- > `optional` **allowExportFunc**: `boolean`
36
-
37
- #### Defined in
38
-
39
- [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L14)
40
-
41
- ***
42
-
43
- ### apiRoot?
44
-
45
- > `optional` **apiRoot**: `string`
46
-
47
- #### Inherited from
48
-
49
- [`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
50
-
51
- #### Defined in
52
-
53
- [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L34)
54
-
55
- ***
56
-
57
- ### fetchOptions?
58
-
59
- > `optional` **fetchOptions**: `any`
60
-
61
- #### Inherited from
62
-
63
- [`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
64
-
65
- #### Defined in
66
-
67
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L36)
68
-
69
- ***
70
-
71
- ### isApi?
72
-
73
- > `optional` **isApi**: `boolean`
74
-
75
- #### Inherited from
76
-
77
- [`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
78
-
79
- #### Defined in
80
-
81
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L47)
82
-
83
- ***
84
-
85
- ### name?
86
-
87
- > `optional` **name**: `string`
88
-
89
- #### Inherited from
90
-
91
- [`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
92
-
93
- #### Defined in
94
-
95
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L41)
96
-
97
- ***
98
-
99
- ### params?
100
-
101
- > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
102
-
103
- #### Inherited from
104
-
105
- [`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
106
-
107
- #### Defined in
108
-
109
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L42)
110
-
111
- ***
112
-
113
- ### result?
114
-
115
- > `optional` **result**: `string`
116
-
117
- #### Inherited from
118
-
119
- [`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
120
-
121
- #### Defined in
122
-
123
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L43)
124
-
125
- ***
126
-
127
- ### scope?
128
-
129
- > `optional` **scope**: `any`
130
-
131
- #### Inherited from
132
-
133
- [`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
134
-
135
- #### Defined in
136
-
137
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L44)
138
-
139
- ***
140
-
141
- ### setup()?
142
-
143
- > `optional` **setup**: (`this`, `options`?) => `void`
144
-
145
- #### Parameters
146
-
147
- • **this**: [`ToolFunc`](../classes/ToolFunc.md)
148
-
149
- • **options?**: [`FuncItem`](FuncItem.md)
150
-
151
- #### Returns
152
-
153
- `void`
154
-
155
- #### Inherited from
156
-
157
- [`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
158
-
159
- #### Defined in
160
-
161
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L46)
162
-
163
- ***
164
-
165
- ### stream?
166
-
167
- > `optional` **stream**: `boolean`
168
-
169
- #### Inherited from
170
-
171
- [`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
172
-
173
- #### Defined in
174
-
175
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L48)
176
-
177
- ***
178
-
179
- ### tags?
180
-
181
- > `optional` **tags**: `string` \| `string`[]
182
-
183
- #### Inherited from
184
-
185
- [`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)
186
-
187
- #### Defined in
188
-
189
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L45)
package/docs/interfaces/ServerFuncParams.md DELETED
@@ -1,37 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ServerFuncParams
6
-
7
- # Interface: ServerFuncParams
8
-
9
- Convention: Always pass _req, _res
10
-
11
- ## Extended by
12
-
13
- - [`EventServerFuncParams`](EventServerFuncParams.md)
14
-
15
- ## Indexable
16
-
17
- \[`name`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### \_req?
22
-
23
- > `optional` **\_req**: `IncomingMessage`
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L9)
28
-
29
- ***
30
-
31
- ### \_res?
32
-
33
- > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
34
-
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L10)
package/docs/interfaces/SplitSentenceOptions.md DELETED
@@ -1,47 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / SplitSentenceOptions
6
-
7
- # Interface: SplitSentenceOptions
8
-
9
- ## Properties
10
-
11
- ### best?
12
-
13
- > `optional` **best**: `boolean`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/split-sentence.ts:26](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L26)
18
-
19
- ***
20
-
21
- ### completeSentence?
22
-
23
- > `optional` **completeSentence**: `boolean`
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/split-sentence.ts:27](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L27)
28
-
29
- ***
30
-
31
- ### ignoreEmptyLine?
32
-
33
- > `optional` **ignoreEmptyLine**: `boolean`
34
-
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L29)
38
-
39
- ***
40
-
41
- ### isMarkdown?
42
-
43
- > `optional` **isMarkdown**: `boolean`
44
-
45
- #### Defined in
46
-
47
- [packages/ai-tool/src/utils/split-sentence.ts:28](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L28)