@isdk/ai-tool 0.4.0 → 0.5.1

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 (344) 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 +204 -237
  10. package/dist/index.d.ts +204 -237
  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/docs/README.md +1 -1
  16. package/docs/classes/AbortError.md +80 -82
  17. package/docs/classes/AlreadyExistsError.md +80 -82
  18. package/docs/classes/BaseError.md +81 -81
  19. package/docs/classes/BinarySemaphore.md +418 -0
  20. package/docs/classes/CancelableAbility.md +193 -105
  21. package/docs/classes/ClientTools.md +655 -631
  22. package/docs/classes/CommonError.md +85 -85
  23. package/docs/classes/ConfigFile.md +131 -111
  24. package/docs/classes/EnvPromptTemplate.md +1158 -0
  25. package/docs/classes/EventClient.md +766 -736
  26. package/docs/classes/EventEmitter.md +299 -0
  27. package/docs/classes/EventServer.md +783 -757
  28. package/docs/classes/EventToolFunc.md +612 -588
  29. package/docs/classes/FStringPromptTemplate.md +246 -238
  30. package/docs/classes/FewShotPromptTemplate.md +240 -246
  31. package/docs/classes/GolangPromptTemplate.md +246 -238
  32. package/docs/classes/HFEnvironment.md +42 -44
  33. package/docs/classes/HFInterpreter.md +22 -20
  34. package/docs/classes/HFTemplate.md +19 -19
  35. package/docs/classes/HfPromptTemplate.md +246 -238
  36. package/docs/classes/IntSet.md +53 -53
  37. package/docs/classes/LRUCache.md +601 -0
  38. package/docs/classes/NotFoundError.md +80 -82
  39. package/docs/classes/NotImplementationError.md +80 -82
  40. package/docs/classes/PromptExampleSelector.md +39 -39
  41. package/docs/classes/PromptTemplate.md +235 -226
  42. package/docs/classes/ReadableStreamError.md +82 -84
  43. package/docs/classes/ResClientTools.md +662 -630
  44. package/docs/classes/ResServerTools.md +648 -626
  45. package/docs/classes/SSEChannel.md +61 -61
  46. package/docs/classes/Semaphore.md +401 -40
  47. package/docs/classes/ServerTools.md +622 -608
  48. package/docs/classes/SignalGate.md +182 -0
  49. package/docs/classes/TaskAbortController.md +27 -33
  50. package/docs/classes/ToolFunc.md +582 -552
  51. package/docs/classes/YamlTypeBaseObject.md +9 -7
  52. package/docs/enumerations/AsyncFeatureBits.md +6 -10
  53. package/docs/enumerations/AsyncFeatures.md +6 -10
  54. package/docs/enumerations/ErrorCode.md +24 -64
  55. package/docs/enumerations/HashAlgorithm.md +14 -34
  56. package/docs/functions/AIArgProcessor.md +15 -9
  57. package/docs/functions/AIStream.md +9 -7
  58. package/docs/functions/ChoiceArgProcessor.md +15 -9
  59. package/docs/functions/ObjectArgsToArgsInfo.md +29 -0
  60. package/docs/functions/RateLimit.md +13 -9
  61. package/docs/functions/TemplateArgProcessor.md +15 -9
  62. package/docs/functions/assignDirs.md +33 -0
  63. package/docs/functions/backendEventable.md +14 -8
  64. package/docs/functions/beforeShutdown.md +29 -0
  65. package/docs/functions/canonicalize.md +6 -6
  66. package/docs/functions/completeSentences.md +9 -7
  67. package/docs/functions/concatText.md +8 -6
  68. package/docs/functions/countLLMTokens.md +9 -7
  69. package/docs/functions/countRegexMatches.md +9 -7
  70. package/docs/functions/createAbilityInjector.md +66 -34
  71. package/docs/functions/createCallbacksTransformer.md +6 -6
  72. package/docs/functions/createEmptyReadableStream.md +3 -5
  73. package/docs/functions/createEndWithRepetitionDetector.md +9 -7
  74. package/docs/functions/createError.md +12 -8
  75. package/docs/functions/createEventStreamTransformer.md +8 -8
  76. package/docs/functions/createHfValueFunc.md +9 -7
  77. package/docs/functions/createLRUCache.md +9 -7
  78. package/docs/functions/createYamlObjectTag.md +9 -7
  79. package/docs/functions/dateToText.md +9 -7
  80. package/docs/functions/decodeCharset.md +9 -7
  81. package/docs/functions/detectCharset.md +9 -7
  82. package/docs/functions/encodeLLMTokens.md +9 -7
  83. package/docs/functions/ensureQuoted.md +25 -0
  84. package/docs/functions/eventable.md +82 -0
  85. package/docs/functions/expandConfig.md +25 -0
  86. package/docs/functions/expandEnv.md +6 -6
  87. package/docs/functions/expandObjEnv.md +12 -8
  88. package/docs/functions/expandPath.md +25 -0
  89. package/docs/functions/extNameLevel.md +6 -6
  90. package/docs/functions/fileIsExists.md +6 -6
  91. package/docs/functions/filenameReservedRegex.md +3 -5
  92. package/docs/functions/filterValidFnScope.md +6 -6
  93. package/docs/functions/findIndexNonEmptyFrom.md +9 -7
  94. package/docs/functions/findPort.md +9 -7
  95. package/docs/functions/formatISO.md +9 -11
  96. package/docs/functions/formatTextWithSpace.md +13 -9
  97. package/docs/functions/getAllEnumKeys.md +8 -8
  98. package/docs/functions/getConfigFileNames.md +9 -7
  99. package/docs/functions/getConfigs.md +9 -7
  100. package/docs/functions/getEnvVairables.md +21 -0
  101. package/docs/functions/getFileMetaInfo.md +6 -6
  102. package/docs/functions/getHashAlgoBySize.md +6 -6
  103. package/docs/functions/getKeysPath.md +6 -6
  104. package/docs/functions/getLLMTokenizer.md +6 -6
  105. package/docs/functions/getMultiLevelExtname.md +9 -7
  106. package/docs/functions/getPackageDir.md +6 -6
  107. package/docs/functions/getRealFilepath.md +6 -6
  108. package/docs/functions/getResponseErrorReadableStream.md +6 -6
  109. package/docs/functions/getXDGConfigs.md +37 -0
  110. package/docs/functions/hasDirectoryIn.md +9 -7
  111. package/docs/functions/hash.md +25 -0
  112. package/docs/functions/hashFile.md +10 -8
  113. package/docs/functions/hashStream.md +10 -8
  114. package/docs/functions/hfParse.md +6 -6
  115. package/docs/functions/hfTokenize.md +9 -7
  116. package/docs/functions/initShutdown.md +15 -0
  117. package/docs/functions/interpolateEnv.md +13 -9
  118. package/docs/functions/interpolateFString.md +9 -7
  119. package/docs/functions/interpolateGolangTemplate.md +12 -8
  120. package/docs/functions/isLangUsingSpaces.md +6 -6
  121. package/docs/functions/isListItemString.md +6 -6
  122. package/docs/functions/isModelNameMatched.md +9 -7
  123. package/docs/functions/isPunctuationChar.md +6 -6
  124. package/docs/functions/isQuoted.md +21 -0
  125. package/docs/functions/isRegExp.md +6 -6
  126. package/docs/functions/isSameString.md +36 -0
  127. package/docs/functions/isSectionString.md +9 -7
  128. package/docs/functions/isSentenceEnding.md +6 -6
  129. package/docs/functions/isSepLineString.md +6 -6
  130. package/docs/functions/isStrWrapped.md +25 -0
  131. package/docs/functions/isSubdirectory.md +9 -7
  132. package/docs/functions/isTitleString.md +9 -7
  133. package/docs/functions/isValidFilename.md +6 -6
  134. package/docs/functions/isValidFilepath.md +6 -6
  135. package/docs/functions/isWebStream.md +6 -6
  136. package/docs/functions/jsonFilterToWhere.md +9 -7
  137. package/docs/functions/jsonToMarkdownStr.md +18 -10
  138. package/docs/functions/loadAIConfig.md +21 -0
  139. package/docs/functions/loadConfig.md +25 -0
  140. package/docs/functions/loadConfigFile.md +25 -0
  141. package/docs/functions/loadFileFromPaths.md +24 -14
  142. package/docs/functions/loadTextFromPaths.md +18 -10
  143. package/docs/functions/lrucache.md +17 -11
  144. package/docs/functions/makeToolFuncCancelable.md +14 -8
  145. package/docs/functions/matchUrlProtocol.md +6 -6
  146. package/docs/functions/memoize.md +9 -7
  147. package/docs/functions/messagesToText.md +6 -6
  148. package/docs/functions/paramsSizeToScaleStr.md +9 -7
  149. package/docs/functions/parseCommand.md +13 -9
  150. package/docs/functions/parseDateFormat.md +15 -13
  151. package/docs/functions/parseFString.md +6 -6
  152. package/docs/functions/parseISO.md +9 -11
  153. package/docs/functions/parseJsJson.md +9 -7
  154. package/docs/functions/parseJsJsonSimpleSync.md +9 -7
  155. package/docs/functions/parseObjectArgInfo.md +15 -9
  156. package/docs/functions/parseObjectArgumentInfos.md +12 -8
  157. package/docs/functions/parseObjectArguments.md +12 -8
  158. package/docs/functions/parseObjectArgumentsAsArgInfos.md +12 -8
  159. package/docs/functions/parseYaml.md +11 -7
  160. package/docs/functions/quoteStr.md +6 -6
  161. package/docs/functions/reControlCharsRegex.md +3 -5
  162. package/docs/functions/readFilenamesRecursiveSync.md +16 -10
  163. package/docs/functions/readTextFileChunks.md +9 -7
  164. package/docs/functions/readTextFileChunksEx.md +9 -7
  165. package/docs/functions/readableFromAsyncIterable.md +6 -6
  166. package/docs/functions/registerCoreTools.md +3 -5
  167. package/docs/functions/registerYamlTag.md +6 -6
  168. package/docs/functions/removeMarkdownBold.md +9 -7
  169. package/docs/functions/removeMarkdownBoldAndItalic.md +9 -7
  170. package/docs/functions/removeMarkdownItalic.md +9 -7
  171. package/docs/functions/replaceWithPlaceholder.md +11 -9
  172. package/docs/functions/restoreFromPlacehoders.md +12 -8
  173. package/docs/functions/sanitizeFilename.md +9 -7
  174. package/docs/functions/sanitizeFilepath.md +9 -7
  175. package/docs/functions/saveConfigFile.md +12 -8
  176. package/docs/functions/scaleStrToParamsSize.md +6 -6
  177. package/docs/functions/shutdown.md +33 -0
  178. package/docs/functions/simplifyObjectArguments.md +6 -6
  179. package/docs/functions/sortedValues.md +6 -6
  180. package/docs/functions/splitChunks.md +9 -7
  181. package/docs/functions/splitParagraph.md +9 -7
  182. package/docs/functions/splitSentence.md +9 -7
  183. package/docs/functions/stringifyYaml.md +11 -7
  184. package/docs/functions/stripConsoleColor.md +6 -6
  185. package/docs/functions/textToDate.md +9 -7
  186. package/docs/functions/throwError.md +12 -8
  187. package/docs/functions/toDate.md +9 -11
  188. package/docs/functions/toDateTime.md +6 -6
  189. package/docs/functions/toRegExp.md +6 -6
  190. package/docs/functions/trimStartOfStreamHelper.md +6 -6
  191. package/docs/functions/truncTo.md +12 -8
  192. package/docs/functions/truncateByToken.md +9 -7
  193. package/docs/functions/truncateToTokenLimit.md +9 -7
  194. package/docs/functions/truncateToTokenLimitEx.md +9 -7
  195. package/docs/functions/uuid.md +9 -7
  196. package/docs/functions/uuidParse.md +6 -6
  197. package/docs/functions/uuidStringify.md +10 -8
  198. package/docs/functions/uuidValidate.md +6 -6
  199. package/docs/functions/uuidVersion.md +6 -6
  200. package/docs/functions/uuidv1.md +28 -20
  201. package/docs/functions/uuidv4.md +28 -20
  202. package/docs/functions/uuidv5.md +34 -22
  203. package/docs/functions/wait.md +6 -6
  204. package/docs/functions/wrapEventEmitter.md +27 -0
  205. package/docs/functions/xxhash.md +12 -8
  206. package/docs/functions/xxhash32.md +9 -7
  207. package/docs/functions/xxhash64.md +9 -7
  208. package/docs/functions/xxhashAsStr.md +12 -8
  209. package/docs/globals.md +45 -1
  210. package/docs/interfaces/AIChatAssistantMessageParam.md +42 -30
  211. package/docs/interfaces/AIChatContentPartImage.md +6 -8
  212. package/docs/interfaces/AIChatContentPartText.md +5 -7
  213. package/docs/interfaces/AIChatMessageParamBase.md +23 -13
  214. package/docs/interfaces/AIChatMessageToolCall.md +7 -11
  215. package/docs/interfaces/AIChatSystemMessageParam.md +40 -22
  216. package/docs/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  217. package/docs/interfaces/AIChatToolChoiceObject.md +25 -0
  218. package/docs/interfaces/AIChatToolFunc.md +41 -0
  219. package/docs/interfaces/AIChatToolFuncParam.md +37 -0
  220. package/docs/interfaces/AIChatToolMessageParam.md +40 -24
  221. package/docs/interfaces/AIChatToolParam.md +25 -0
  222. package/docs/interfaces/AIChatToolTypeObject.md +17 -0
  223. package/docs/interfaces/AIChatUserMessageParam.md +44 -34
  224. package/docs/interfaces/AIChoiceConfig.md +10 -22
  225. package/docs/interfaces/AIResult.md +13 -21
  226. package/docs/interfaces/AIStreamParser.md +11 -7
  227. package/docs/interfaces/AIStreamParserOptions.md +5 -5
  228. package/docs/interfaces/BaseFunc.md +30 -40
  229. package/docs/interfaces/BaseFuncItem.md +18 -28
  230. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  231. package/docs/interfaces/BinarySemaphoreOptions.md +57 -0
  232. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  233. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  234. package/docs/interfaces/CancelableAbilityOptions.md +27 -29
  235. package/docs/interfaces/ClientFuncItem.md +31 -47
  236. package/docs/interfaces/DotenvExpandOptions.md +8 -12
  237. package/docs/interfaces/DotenvExpandOutput.md +5 -7
  238. package/docs/interfaces/DotenvParseInput.md +4 -2
  239. package/docs/interfaces/DotenvParseOutput.md +4 -2
  240. package/docs/interfaces/DotenvPopulateInput.md +4 -2
  241. package/docs/interfaces/EventClientFuncParams.md +11 -15
  242. package/docs/interfaces/EventServerFuncParams.md +14 -18
  243. package/docs/interfaces/FewShotPromptTemplateOptions.md +29 -45
  244. package/docs/interfaces/FuncItem.md +26 -38
  245. package/docs/interfaces/FuncParam.md +11 -21
  246. package/docs/interfaces/FuncParams.md +4 -2
  247. package/docs/interfaces/Funcs.md +4 -2
  248. package/docs/interfaces/HashAlgoParams.md +6 -10
  249. package/docs/interfaces/IFileMetaInfo.md +10 -22
  250. package/docs/interfaces/IReadTextFileChunksOptions.md +29 -43
  251. package/docs/interfaces/ITruncateToTokenLimitOptions.md +19 -31
  252. package/docs/interfaces/JsonFilter.md +4 -2
  253. package/docs/interfaces/ParseObjectArgumentOptions.md +13 -31
  254. package/docs/interfaces/PromptExampleSelectorOptions.md +8 -10
  255. package/docs/interfaces/PromptTemplateOptions.md +10 -20
  256. package/docs/interfaces/RemoteFuncItem.md +28 -44
  257. package/docs/interfaces/ReplacePlacehoderOptions.md +7 -13
  258. package/docs/interfaces/ResClientFuncParams.md +10 -8
  259. package/docs/interfaces/ResServerFuncParams.md +15 -19
  260. package/docs/interfaces/SanitizeFilenameOptions.md +5 -7
  261. package/docs/interfaces/SectionStringOptions.md +5 -7
  262. package/docs/interfaces/SemaphoreOptions.md +89 -0
  263. package/docs/interfaces/SemaphoreTaskItem.md +73 -0
  264. package/docs/interfaces/ServerFuncItem.md +32 -50
  265. package/docs/interfaces/ServerFuncParams.md +6 -8
  266. package/docs/interfaces/SplitSentenceOptions.md +7 -13
  267. package/docs/interfaces/StreamCallbacksAndOptions.md +26 -22
  268. package/docs/interfaces/TaskAbortControllers.md +4 -2
  269. package/docs/interfaces/TaskPromise.md +24 -24
  270. package/docs/interfaces/ToolFuncPackage.md +11 -13
  271. package/docs/namespaces/EventStates/README.md +14 -0
  272. package/docs/namespaces/EventStates/variables/ABORT.md +11 -0
  273. package/docs/namespaces/EventStates/variables/CONTINUE.md +11 -0
  274. package/docs/namespaces/EventStates/variables/DONE.md +11 -0
  275. package/docs/namespaces/EventStates/variables/STOPPED.md +11 -0
  276. package/docs/namespaces/uuidv5/README.md +12 -0
  277. package/docs/namespaces/uuidv5/variables/DNS.md +11 -0
  278. package/docs/namespaces/uuidv5/variables/URL.md +11 -0
  279. package/docs/type-aliases/AIChatContentPart.md +2 -4
  280. package/docs/type-aliases/AIChatMessageParam.md +3 -5
  281. package/docs/type-aliases/AIChatRole.md +2 -4
  282. package/docs/type-aliases/AIChatToolChoiceParam.md +11 -0
  283. package/docs/type-aliases/AIMessageType.md +2 -4
  284. package/docs/type-aliases/AIModelNameRule.md +2 -4
  285. package/docs/type-aliases/AIModelNameRuleFn.md +6 -6
  286. package/docs/type-aliases/AIModelNameRules.md +2 -4
  287. package/docs/type-aliases/AITextGenerationFinishReason.md +2 -4
  288. package/docs/type-aliases/ActionName.md +2 -4
  289. package/docs/type-aliases/AsyncTaskId.md +2 -4
  290. package/docs/type-aliases/BeforeShutdownListener.md +23 -0
  291. package/docs/type-aliases/EventErrorListenerFn.md +15 -9
  292. package/docs/type-aliases/EventListenerFn.md +12 -8
  293. package/docs/type-aliases/FStringPromptTemplateNode.md +4 -6
  294. package/docs/type-aliases/FuncParamType.md +2 -4
  295. package/docs/type-aliases/PromptExamples.md +3 -5
  296. package/docs/type-aliases/PromptTemplateType.md +2 -4
  297. package/docs/type-aliases/PromptType.md +2 -4
  298. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +15 -0
  299. package/docs/type-aliases/TFunc.md +9 -7
  300. package/docs/variables/AIChatRoles.md +3 -5
  301. package/docs/variables/AIMessageTypes.md +3 -5
  302. package/docs/variables/AITextGenerationFinishReasons.md +3 -5
  303. package/docs/variables/AbortErrorCode.md +2 -4
  304. package/docs/variables/ActionNames.md +3 -5
  305. package/docs/variables/AlreadyExistsErrorCode.md +2 -4
  306. package/docs/variables/ClientToolFuncSchema.md +40 -26
  307. package/docs/variables/DEFAULT_CONFIG_NAME.md +11 -0
  308. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +2 -4
  309. package/docs/variables/EventBusName.md +2 -4
  310. package/docs/variables/EventName.md +2 -4
  311. package/docs/variables/FilenameReservedRegex.md +3 -5
  312. package/docs/variables/HFBuiltins.md +42 -12
  313. package/docs/variables/InternalErrorCode.md +2 -4
  314. package/docs/variables/LLM_TOKENIZER_NAMES.md +5 -7
  315. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +2 -4
  316. package/docs/variables/NotFoundErrorCode.md +2 -4
  317. package/docs/variables/NotImplementedErrorCode.md +2 -4
  318. package/docs/variables/PASSING_SCORE.md +2 -4
  319. package/docs/variables/PromptTemplateTypes.md +3 -5
  320. package/docs/variables/PromptTypes.md +4 -6
  321. package/docs/variables/RStreamErrCode.md +2 -4
  322. package/docs/variables/RemoteToolFuncSchema.md +40 -26
  323. package/docs/variables/ResponseRStreamErrCode.md +2 -4
  324. package/docs/variables/SHUTDOWN_SIGNALS.md +17 -0
  325. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +2 -4
  326. package/docs/variables/SecondaryCache.md +11 -0
  327. package/docs/variables/ServerToolFuncSchema.md +40 -26
  328. package/docs/variables/ToolAsyncCancelableBit.md +2 -4
  329. package/docs/variables/ToolAsyncMultiTaskBit.md +2 -4
  330. package/docs/variables/ToolAsyncPriorityBit.md +2 -4
  331. package/docs/variables/ToolFuncSchema.md +33 -25
  332. package/docs/variables/WindowsReservedNameRegex.md +3 -5
  333. package/docs/variables/base32768.md +2 -4
  334. package/docs/variables/defaultTemplateFormat.md +2 -4
  335. package/docs/variables/event.md +2 -4
  336. package/docs/variables/eventClient.md +2 -4
  337. package/docs/variables/eventServer.md +2 -4
  338. package/docs/variables/lrucache.md +2 -4
  339. package/docs/variables/mimeType.md +2 -4
  340. package/docs/variables/uuidNIL.md +3 -5
  341. package/package.json +31 -31
  342. package/dist/chunk-SIP3XWIH.mjs +0 -1
  343. package/dist/index-BC3GQn6-.d.mts +0 -488
  344. package/dist/index-BC3GQn6-.d.ts +0 -488
package/docs/interfaces/CancelableAbilityOptions.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,19 +6,23 @@
6
6
 
7
7
  # Interface: CancelableAbilityOptions
8
8
 
9
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L29)
10
+
9
11
  ## Extends
10
12
 
11
13
  - `AbilityOptions`
12
14
 
15
+ ## Indexable
16
+
17
+ \[`name`: `string`\]: `any`
18
+
13
19
  ## Properties
14
20
 
15
21
  ### asyncFeatures?
16
22
 
17
23
  > `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
18
24
 
19
- #### Defined in
20
-
21
- [packages/ai-tool/src/utils/cancelable-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/cancelable-ability.ts#L11)
25
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L30)
22
26
 
23
27
  ***
24
28
 
@@ -26,55 +30,55 @@
26
30
 
27
31
  > `optional` **classMethods**: `Record`\<`string`, `Function`\>
28
32
 
33
+ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:13
34
+
29
35
  #### Inherited from
30
36
 
31
37
  `AbilityOptions.classMethods`
32
38
 
33
- #### Defined in
34
-
35
- node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:13
36
-
37
39
  ***
38
40
 
39
41
  ### exclude?
40
42
 
41
43
  > `optional` **exclude**: `string` \| `string`[]
42
44
 
45
+ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:11
46
+
43
47
  #### Inherited from
44
48
 
45
49
  `AbilityOptions.exclude`
46
50
 
47
- #### Defined in
48
-
49
- node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:11
50
-
51
51
  ***
52
52
 
53
53
  ### id?
54
54
 
55
55
  > `optional` **id**: `string`
56
56
 
57
+ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:8
58
+
57
59
  #### Inherited from
58
60
 
59
61
  `AbilityOptions.id`
60
62
 
61
- #### Defined in
62
-
63
- node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:8
64
-
65
63
  ***
66
64
 
67
65
  ### include?
68
66
 
69
67
  > `optional` **include**: `string` \| `string`[]
70
68
 
69
+ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:10
70
+
71
71
  #### Inherited from
72
72
 
73
73
  `AbilityOptions.include`
74
74
 
75
- #### Defined in
75
+ ***
76
+
77
+ ### isReadyFn?
78
+
79
+ > `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
76
80
 
77
- node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:10
81
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L32)
78
82
 
79
83
  ***
80
84
 
@@ -82,9 +86,7 @@ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom
82
86
 
83
87
  > `optional` **maxTaskConcurrency**: `number`
84
88
 
85
- #### Defined in
86
-
87
- [packages/ai-tool/src/utils/cancelable-ability.ts:12](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/cancelable-ability.ts#L12)
89
+ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/cancelable-ability.ts#L31)
88
90
 
89
91
  ***
90
92
 
@@ -92,24 +94,20 @@ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom
92
94
 
93
95
  > `optional` **methods**: `Record`\<`string`, `Function`\>
94
96
 
97
+ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:12
98
+
95
99
  #### Inherited from
96
100
 
97
101
  `AbilityOptions.methods`
98
102
 
99
- #### Defined in
100
-
101
- node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:12
102
-
103
103
  ***
104
104
 
105
105
  ### mode?
106
106
 
107
107
  > `optional` **mode**: `number`
108
108
 
109
+ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:9
110
+
109
111
  #### Inherited from
110
112
 
111
113
  `AbilityOptions.mode`
112
-
113
- #### Defined in
114
-
115
- node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:9
package/docs/interfaces/ClientFuncItem.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,6 +6,8 @@
6
6
 
7
7
  # Interface: ClientFuncItem
8
8
 
9
+ Defined in: [packages/ai-tool/src/client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/client-tools.ts#L5)
10
+
9
11
  ## Extends
10
12
 
11
13
  - [`RemoteFuncItem`](RemoteFuncItem.md)
@@ -20,123 +22,113 @@
20
22
 
21
23
  > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
22
24
 
25
+ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/consts.ts#L35)
26
+
23
27
  #### Inherited from
24
28
 
25
29
  [`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
26
30
 
27
- #### Defined in
28
-
29
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/consts.ts#L35)
30
-
31
31
  ***
32
32
 
33
33
  ### apiRoot?
34
34
 
35
35
  > `optional` **apiRoot**: `string`
36
36
 
37
+ Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/consts.ts#L34)
38
+
37
39
  #### Inherited from
38
40
 
39
41
  [`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
40
42
 
41
- #### Defined in
42
-
43
- [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/consts.ts#L34)
44
-
45
43
  ***
46
44
 
47
45
  ### fetchOptions?
48
46
 
49
47
  > `optional` **fetchOptions**: `any`
50
48
 
49
+ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/consts.ts#L36)
50
+
51
51
  #### Inherited from
52
52
 
53
53
  [`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
54
54
 
55
- #### Defined in
56
-
57
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/consts.ts#L36)
58
-
59
55
  ***
60
56
 
61
57
  ### isApi?
62
58
 
63
59
  > `optional` **isApi**: `boolean`
64
60
 
61
+ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L29)
62
+
65
63
  #### Inherited from
66
64
 
67
65
  [`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
68
66
 
69
- #### Defined in
70
-
71
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L47)
72
-
73
67
  ***
74
68
 
75
69
  ### name?
76
70
 
77
71
  > `optional` **name**: `string`
78
72
 
73
+ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L23)
74
+
79
75
  #### Inherited from
80
76
 
81
77
  [`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
82
78
 
83
- #### Defined in
84
-
85
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L41)
86
-
87
79
  ***
88
80
 
89
81
  ### params?
90
82
 
91
83
  > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
92
84
 
85
+ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L24)
86
+
93
87
  #### Inherited from
94
88
 
95
89
  [`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
96
90
 
97
- #### Defined in
98
-
99
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L42)
100
-
101
91
  ***
102
92
 
103
93
  ### result?
104
94
 
105
95
  > `optional` **result**: `string`
106
96
 
97
+ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L25)
98
+
107
99
  #### Inherited from
108
100
 
109
101
  [`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
110
102
 
111
- #### Defined in
112
-
113
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L43)
114
-
115
103
  ***
116
104
 
117
105
  ### scope?
118
106
 
119
107
  > `optional` **scope**: `any`
120
108
 
109
+ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L26)
110
+
121
111
  #### Inherited from
122
112
 
123
113
  [`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
124
114
 
125
- #### Defined in
126
-
127
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L44)
128
-
129
115
  ***
130
116
 
131
117
  ### setup()?
132
118
 
133
119
  > `optional` **setup**: (`this`, `options`?) => `void`
134
120
 
121
+ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L28)
122
+
135
123
  #### Parameters
136
124
 
137
- • **this**: [`ToolFunc`](../classes/ToolFunc.md)
125
+ ##### this
126
+
127
+ [`ToolFunc`](../classes/ToolFunc.md)
138
128
 
139
- • **options?**: [`FuncItem`](FuncItem.md)
129
+ ##### options?
130
+
131
+ [`FuncItem`](FuncItem.md)
140
132
 
141
133
  #### Returns
142
134
 
@@ -146,34 +138,26 @@
146
138
 
147
139
  [`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
148
140
 
149
- #### Defined in
150
-
151
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L46)
152
-
153
141
  ***
154
142
 
155
143
  ### stream?
156
144
 
157
145
  > `optional` **stream**: `boolean`
158
146
 
147
+ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L30)
148
+
159
149
  #### Inherited from
160
150
 
161
151
  [`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
162
152
 
163
- #### Defined in
164
-
165
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L48)
166
-
167
153
  ***
168
154
 
169
155
  ### tags?
170
156
 
171
157
  > `optional` **tags**: `string` \| `string`[]
172
158
 
159
+ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/tool-func.ts#L27)
160
+
173
161
  #### Inherited from
174
162
 
175
163
  [`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)
176
-
177
- #### Defined in
178
-
179
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/tool-func.ts#L45)
package/docs/interfaces/DotenvExpandOptions.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,15 +6,15 @@
6
6
 
7
7
  # Interface: DotenvExpandOptions
8
8
 
9
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:202](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L202)
10
+
9
11
  ## Properties
10
12
 
11
13
  ### error?
12
14
 
13
15
  > `optional` **error**: `Error`
14
16
 
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L188)
17
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L203)
18
18
 
19
19
  ***
20
20
 
@@ -22,26 +22,22 @@
22
22
 
23
23
  > `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
24
24
 
25
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:219](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L219)
26
+
25
27
  Default: `object`
26
28
 
27
29
  Object coming from dotenv's parsed result.
28
30
 
29
- #### Defined in
30
-
31
- [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L204)
32
-
33
31
  ***
34
32
 
35
33
  ### processEnv?
36
34
 
37
35
  > `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
38
36
 
37
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:212](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L212)
38
+
39
39
  Default: `process.env`
40
40
 
41
41
  Specify an object to write your secrets to. Defaults to process.env environment variables.
42
42
 
43
43
  example: `const processEnv = {}; require('dotenv').config({ processEnv: processEnv })`
44
-
45
- #### Defined in
46
-
47
- [packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L197)
package/docs/interfaces/DotenvExpandOutput.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,15 +6,15 @@
6
6
 
7
7
  # Interface: DotenvExpandOutput
8
8
 
9
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:222](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L222)
10
+
9
11
  ## Properties
10
12
 
11
13
  ### error?
12
14
 
13
15
  > `optional` **error**: `Error`
14
16
 
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L208)
17
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L223)
18
18
 
19
19
  ***
20
20
 
@@ -22,6 +22,4 @@
22
22
 
23
23
  > `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
24
24
 
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/template/env.ts#L209)
25
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:224](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L224)
package/docs/interfaces/DotenvParseInput.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,6 +6,8 @@
6
6
 
7
7
  # Interface: DotenvParseInput
8
8
 
9
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:194](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L194)
10
+
9
11
  ## Indexable
10
12
 
11
- \[`name`: `string`\]: `string` \| `undefined`
13
+ \[`name`: `string`\]: `undefined` \| `string`
package/docs/interfaces/DotenvParseOutput.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,6 +6,8 @@
6
6
 
7
7
  # Interface: DotenvParseOutput
8
8
 
9
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:198](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L198)
10
+
9
11
  ## Indexable
10
12
 
11
- \[`name`: `string`\]: `string` \| `undefined`
13
+ \[`name`: `string`\]: `undefined` \| `string`
package/docs/interfaces/DotenvPopulateInput.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,6 +6,8 @@
6
6
 
7
7
  # Interface: DotenvPopulateInput
8
8
 
9
+ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:190](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L190)
10
+
9
11
  ## Indexable
10
12
 
11
- \[`name`: `string`\]: `string` \| `undefined`
13
+ \[`name`: `string`\]: `undefined` \| `string`
package/docs/interfaces/EventClientFuncParams.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,15 +6,15 @@
6
6
 
7
7
  # Interface: EventClientFuncParams
8
8
 
9
+ Defined in: [packages/ai-tool/src/funcs/event-client.ts:5](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-client.ts#L5)
10
+
9
11
  ## Properties
10
12
 
11
13
  ### act?
12
14
 
13
15
  > `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
14
16
 
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-client.ts#L8)
17
+ Defined in: [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-client.ts#L8)
18
18
 
19
19
  ***
20
20
 
@@ -22,9 +22,7 @@
22
22
 
23
23
  > `optional` **data**: `any`
24
24
 
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-client.ts#L7)
25
+ Defined in: [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-client.ts#L7)
28
26
 
29
27
  ***
30
28
 
@@ -32,9 +30,7 @@
32
30
 
33
31
  > `optional` **event**: `string` \| `string`[]
34
32
 
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-client.ts#L6)
33
+ Defined in: [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-client.ts#L6)
38
34
 
39
35
  ***
40
36
 
@@ -42,14 +38,14 @@
42
38
 
43
39
  > `optional` **listener**: (...`args`) => `void`
44
40
 
41
+ Defined in: [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-client.ts#L9)
42
+
45
43
  #### Parameters
46
44
 
47
- • ...**args**: `any`[]
45
+ ##### args
46
+
47
+ ...`any`[]
48
48
 
49
49
  #### Returns
50
50
 
51
51
  `void`
52
-
53
- #### Defined in
54
-
55
- [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-client.ts#L9)
package/docs/interfaces/EventServerFuncParams.md CHANGED
@@ -1,4 +1,4 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
1
+ [**@isdk/ai-tool**](../README.md)
2
2
 
3
3
  ***
4
4
 
@@ -6,49 +6,49 @@
6
6
 
7
7
  # Interface: EventServerFuncParams
8
8
 
9
+ Defined in: [packages/ai-tool/src/funcs/event-server.ts:12](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-server.ts#L12)
10
+
9
11
  Convention: Always pass _req, _res
10
12
 
11
13
  ## Extends
12
14
 
13
15
  - [`ServerFuncParams`](ServerFuncParams.md)
14
16
 
17
+ ## Indexable
18
+
19
+ \[`name`: `string`\]: `any`
20
+
15
21
  ## Properties
16
22
 
17
23
  ### \_req?
18
24
 
19
25
  > `optional` **\_req**: `IncomingMessage`
20
26
 
27
+ Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/server-tools.ts#L9)
28
+
21
29
  #### Inherited from
22
30
 
23
31
  [`ServerFuncParams`](ServerFuncParams.md).[`_req`](ServerFuncParams.md#_req)
24
32
 
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/server-tools.ts#L9)
28
-
29
33
  ***
30
34
 
31
35
  ### \_res?
32
36
 
33
37
  > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
34
38
 
39
+ Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/server-tools.ts#L10)
40
+
35
41
  #### Inherited from
36
42
 
37
43
  [`ServerFuncParams`](ServerFuncParams.md).[`_res`](ServerFuncParams.md#_res)
38
44
 
39
- #### Defined in
40
-
41
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/server-tools.ts#L10)
42
-
43
45
  ***
44
46
 
45
47
  ### act?
46
48
 
47
49
  > `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
48
50
 
49
- #### Defined in
50
-
51
- [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-server.ts#L15)
51
+ Defined in: [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-server.ts#L15)
52
52
 
53
53
  ***
54
54
 
@@ -56,9 +56,7 @@ Convention: Always pass _req, _res
56
56
 
57
57
  > `optional` **data**: `any`
58
58
 
59
- #### Defined in
60
-
61
- [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-server.ts#L14)
59
+ Defined in: [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-server.ts#L14)
62
60
 
63
61
  ***
64
62
 
@@ -66,6 +64,4 @@ Convention: Always pass _req, _res
66
64
 
67
65
  > `optional` **event**: `string` \| `string`[]
68
66
 
69
- #### Defined in
70
-
71
- [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/funcs/event-server.ts#L13)
67
+ Defined in: [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/funcs/event-server.ts#L13)