@isdk/ai-tool 0.2.0 → 0.2.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 (248) hide show
  1. package/dist/chunk-TOUPOZHH.mjs +1 -0
  2. package/dist/funcs.d.mts +1 -1
  3. package/dist/funcs.d.ts +1 -1
  4. package/dist/funcs.js +1 -1
  5. package/dist/funcs.mjs +1 -1
  6. package/dist/{index-nP9lSU6E.d.mts → index-DUEs7T8M.d.mts} +2 -2
  7. package/dist/{index-nP9lSU6E.d.ts → index-DUEs7T8M.d.ts} +2 -2
  8. package/dist/index.d.mts +3 -3
  9. package/dist/index.d.ts +3 -3
  10. package/dist/index.js +1 -1
  11. package/dist/index.mjs +1 -1
  12. package/docs/README.md +5 -3
  13. package/docs/_media/CONTRIBUTING.md +18 -0
  14. package/docs/_media/LICENSE-MIT +22 -0
  15. package/docs/classes/AbortError.md +108 -129
  16. package/docs/classes/AlreadyExistsError.md +105 -126
  17. package/docs/classes/BaseError.md +112 -125
  18. package/docs/classes/CancelableAbility.md +136 -188
  19. package/docs/classes/ClientTools.md +1005 -1107
  20. package/docs/classes/CommonError.md +115 -136
  21. package/docs/classes/ConfigFile.md +150 -163
  22. package/docs/classes/EventClient.md +1128 -1282
  23. package/docs/classes/EventServer.md +1165 -1303
  24. package/docs/classes/EventToolFunc.md +958 -1028
  25. package/docs/classes/FStringPromptTemplate.md +352 -438
  26. package/docs/classes/FewShotPromptTemplate.md +364 -464
  27. package/docs/classes/GolangPromptTemplate.md +352 -438
  28. package/docs/classes/HFEnvironment.md +53 -79
  29. package/docs/classes/HFInterpreter.md +20 -377
  30. package/docs/classes/HFTemplate.md +21 -33
  31. package/docs/classes/HfPromptTemplate.md +352 -438
  32. package/docs/classes/IntSet.md +67 -100
  33. package/docs/classes/NotFoundError.md +105 -126
  34. package/docs/classes/NotImplementationError.md +105 -126
  35. package/docs/classes/PromptExampleSelector.md +58 -70
  36. package/docs/classes/PromptTemplate.md +338 -422
  37. package/docs/classes/ReadableStreamError.md +108 -129
  38. package/docs/classes/ResClientTools.md +916 -1026
  39. package/docs/classes/ResServerTools.md +919 -1026
  40. package/docs/classes/SSEChannel.md +93 -112
  41. package/docs/classes/Semaphore.md +44 -140
  42. package/docs/classes/ServerTools.md +981 -1072
  43. package/docs/classes/TaskAbortController.md +46 -66
  44. package/docs/classes/ToolFunc.md +840 -910
  45. package/docs/enumerations/AsyncFeatureBits.md +37 -0
  46. package/docs/enumerations/AsyncFeatures.md +37 -0
  47. package/docs/enumerations/ErrorCode.md +217 -0
  48. package/docs/enumerations/XXHashAlgorithm.md +27 -0
  49. package/docs/functions/AIArgProcessor.md +27 -0
  50. package/docs/functions/AIStream.md +50 -0
  51. package/docs/functions/ChoiceArgProcessor.md +27 -0
  52. package/docs/functions/RateLimit.md +33 -0
  53. package/docs/functions/TemplateArgProcessor.md +27 -0
  54. package/docs/functions/backendEventable.md +23 -0
  55. package/docs/functions/canonicalize.md +21 -0
  56. package/docs/functions/countRegexMatches.md +33 -0
  57. package/docs/functions/createAbilityInjector.md +87 -0
  58. package/docs/functions/createCallbacksTransformer.md +49 -0
  59. package/docs/functions/createEmptyReadableStream.md +23 -0
  60. package/docs/functions/createEndWithRepetitionDetector.md +29 -0
  61. package/docs/functions/createError.md +35 -0
  62. package/docs/functions/createEventStreamTransformer.md +33 -0
  63. package/docs/functions/createHfValueFunc.md +29 -0
  64. package/docs/functions/createLRUCache.md +23 -0
  65. package/docs/functions/dateToText.md +23 -0
  66. package/docs/functions/expandEnv.md +40 -0
  67. package/docs/functions/expandObjEnv.md +54 -0
  68. package/docs/functions/extNameLevel.md +43 -0
  69. package/docs/functions/fileIsExists.md +34 -0
  70. package/docs/functions/filenameReservedRegex.md +22 -0
  71. package/docs/functions/filterValidFnScope.md +21 -0
  72. package/docs/functions/findPort.md +23 -0
  73. package/docs/functions/formatISO.md +71 -0
  74. package/docs/functions/getAllEnumKeys.md +31 -0
  75. package/docs/functions/getConfigFileNames.md +23 -0
  76. package/docs/functions/getConfigs.md +23 -0
  77. package/docs/functions/getKeysPath.md +38 -0
  78. package/docs/functions/getMultiLevelExtname.md +31 -0
  79. package/docs/functions/getPackageDir.md +39 -0
  80. package/docs/functions/getRealFilepath.md +34 -0
  81. package/docs/functions/getResponseErrorReadableStream.md +21 -0
  82. package/docs/functions/hfParse.md +24 -0
  83. package/docs/functions/hfTokenize.md +25 -0
  84. package/docs/functions/interpolateEnv.md +25 -0
  85. package/docs/functions/interpolateFString.md +27 -0
  86. package/docs/functions/interpolateGolangTemplate.md +31 -0
  87. package/docs/functions/isModelNameMatched.md +45 -0
  88. package/docs/functions/isValidFilename.md +38 -0
  89. package/docs/functions/isValidFilepath.md +27 -0
  90. package/docs/functions/isWebStream.md +21 -0
  91. package/docs/functions/jsonFilterToWhere.md +45 -0
  92. package/docs/functions/jsonToMarkdownStr.md +31 -0
  93. package/docs/functions/loadFileFromPaths.md +54 -0
  94. package/docs/functions/loadTextFromPaths.md +29 -0
  95. package/docs/functions/lrucache.md +29 -0
  96. package/docs/functions/makeToolFuncCancelable.md +23 -0
  97. package/docs/functions/matchUrlProtocol.md +48 -0
  98. package/docs/functions/memoize.md +27 -0
  99. package/docs/functions/messagesToText.md +21 -0
  100. package/docs/functions/paramsSizeToScaleStr.md +32 -0
  101. package/docs/functions/parseCommand.md +33 -0
  102. package/docs/functions/parseDateFormat.md +360 -0
  103. package/docs/functions/parseFString.md +26 -0
  104. package/docs/functions/parseISO.md +72 -0
  105. package/docs/functions/parseJsJson.md +38 -0
  106. package/docs/functions/parseObjectArgInfo.md +27 -0
  107. package/docs/functions/parseObjectArgumentInfos.md +25 -0
  108. package/docs/functions/parseObjectArguments.md +68 -0
  109. package/docs/functions/parseObjectArgumentsAsArgInfos.md +42 -0
  110. package/docs/functions/parseYaml.md +21 -0
  111. package/docs/functions/quoteStr.md +21 -0
  112. package/docs/functions/reControlCharsRegex.md +21 -0
  113. package/docs/functions/readFilenamesRecursiveSync.md +47 -0
  114. package/docs/functions/readableFromAsyncIterable.md +28 -0
  115. package/docs/functions/registerCoreTools.md +17 -0
  116. package/docs/functions/registerYamlTag.md +21 -0
  117. package/docs/functions/sanitizeFilename.md +37 -0
  118. package/docs/functions/sanitizeFilepath.md +31 -0
  119. package/docs/functions/saveConfigFile.md +25 -0
  120. package/docs/functions/scaleStrToParamsSize.md +27 -0
  121. package/docs/functions/simplifyObjectArguments.md +21 -0
  122. package/docs/functions/sortedValues.md +25 -0
  123. package/docs/functions/splitSentence.md +37 -0
  124. package/docs/functions/stringifyYaml.md +49 -0
  125. package/docs/functions/textToDate.md +23 -0
  126. package/docs/functions/throwError.md +37 -0
  127. package/docs/functions/toDate.md +76 -0
  128. package/docs/functions/toDateTime.md +21 -0
  129. package/docs/functions/trimStartOfStreamHelper.md +41 -0
  130. package/docs/functions/truncTo.md +47 -0
  131. package/docs/functions/uuid.md +23 -0
  132. package/docs/functions/uuidParse.md +21 -0
  133. package/docs/functions/uuidStringify.md +23 -0
  134. package/docs/functions/uuidValidate.md +21 -0
  135. package/docs/functions/uuidVersion.md +21 -0
  136. package/docs/functions/uuidv1.md +47 -0
  137. package/docs/functions/uuidv4.md +47 -0
  138. package/docs/functions/uuidv5.md +51 -0
  139. package/docs/functions/wait.md +21 -0
  140. package/docs/functions/xxhash.md +25 -0
  141. package/docs/functions/xxhash32.md +23 -0
  142. package/docs/functions/xxhash64.md +23 -0
  143. package/docs/functions/xxhashAsStr.md +25 -0
  144. package/docs/globals.md +236 -0
  145. package/docs/interfaces/AIChatAssistantMessageParam.md +29 -38
  146. package/docs/interfaces/AIChatContentPartImage.md +11 -16
  147. package/docs/interfaces/AIChatContentPartText.md +9 -12
  148. package/docs/interfaces/AIChatMessageParamBase.md +12 -19
  149. package/docs/interfaces/AIChatMessageToolCall.md +18 -21
  150. package/docs/interfaces/AIChatSystemMessageParam.md +16 -22
  151. package/docs/interfaces/AIChatToolMessageParam.md +19 -26
  152. package/docs/interfaces/AIChatUserMessageParam.md +32 -42
  153. package/docs/interfaces/AIChoiceConfig.md +31 -39
  154. package/docs/interfaces/AIResult.md +26 -33
  155. package/docs/interfaces/AIStreamParser.md +24 -18
  156. package/docs/interfaces/AIStreamParserOptions.md +8 -10
  157. package/docs/interfaces/BaseFunc.md +55 -75
  158. package/docs/interfaces/BaseFuncItem.md +43 -61
  159. package/docs/interfaces/CancelableAbilityOptions.md +43 -54
  160. package/docs/interfaces/ClientFuncItem.md +66 -83
  161. package/docs/interfaces/DotenvExpandOptions.md +15 -19
  162. package/docs/interfaces/DotenvExpandOutput.md +11 -14
  163. package/docs/interfaces/DotenvParseInput.md +6 -2
  164. package/docs/interfaces/DotenvParseOutput.md +6 -2
  165. package/docs/interfaces/DotenvPopulateInput.md +6 -2
  166. package/docs/interfaces/EventClientFuncParams.md +22 -33
  167. package/docs/interfaces/EventServerFuncParams.md +27 -35
  168. package/docs/interfaces/FewShotPromptTemplateOptions.md +58 -74
  169. package/docs/interfaces/FuncItem.md +53 -70
  170. package/docs/interfaces/FuncParam.md +29 -36
  171. package/docs/interfaces/FuncParams.md +6 -2
  172. package/docs/interfaces/Funcs.md +6 -2
  173. package/docs/interfaces/JsonFilter.md +6 -2
  174. package/docs/interfaces/ParseObjectArgumentOptions.md +23 -29
  175. package/docs/interfaces/PromptExampleSelectorOptions.md +13 -16
  176. package/docs/interfaces/PromptTemplateOptions.md +31 -40
  177. package/docs/interfaces/RemoteFuncItem.md +64 -82
  178. package/docs/interfaces/ResClientFuncParams.md +14 -19
  179. package/docs/interfaces/ResServerFuncParams.md +28 -36
  180. package/docs/interfaces/SanitizeFilenameOptions.md +11 -14
  181. package/docs/interfaces/ServerFuncItem.md +70 -88
  182. package/docs/interfaces/ServerFuncParams.md +15 -20
  183. package/docs/interfaces/StreamCallbacksAndOptions.md +36 -65
  184. package/docs/interfaces/TaskAbortControllers.md +6 -2
  185. package/docs/interfaces/TaskPromise.md +48 -61
  186. package/docs/interfaces/ToolFuncPackage.md +18 -32
  187. package/docs/type-aliases/AIChatContentPart.md +13 -0
  188. package/docs/type-aliases/AIChatMessageParam.md +13 -0
  189. package/docs/type-aliases/AIChatRole.md +13 -0
  190. package/docs/type-aliases/AIMessageType.md +13 -0
  191. package/docs/type-aliases/AIModelNameRule.md +13 -0
  192. package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
  193. package/docs/type-aliases/AIModelNameRules.md +13 -0
  194. package/docs/type-aliases/AITextGenerationFinishReason.md +13 -0
  195. package/docs/type-aliases/ActionName.md +13 -0
  196. package/docs/type-aliases/AsyncTaskId.md +13 -0
  197. package/docs/type-aliases/EventErrorListenerFn.md +27 -0
  198. package/docs/type-aliases/EventListenerFn.md +25 -0
  199. package/docs/type-aliases/FStringPromptTemplateNode.md +16 -0
  200. package/docs/type-aliases/FuncParamType.md +13 -0
  201. package/docs/type-aliases/PromptExamples.md +17 -0
  202. package/docs/type-aliases/PromptTemplateType.md +13 -0
  203. package/docs/type-aliases/PromptType.md +13 -0
  204. package/docs/type-aliases/TFunc.md +23 -0
  205. package/docs/variables/AIChatRoles.md +13 -0
  206. package/docs/variables/AIMessageTypes.md +13 -0
  207. package/docs/variables/AITextGenerationFinishReasons.md +13 -0
  208. package/docs/variables/AbortErrorCode.md +13 -0
  209. package/docs/variables/ActionNames.md +13 -0
  210. package/docs/variables/AlreadyExistsErrorCode.md +13 -0
  211. package/docs/variables/ClientToolFuncSchema.md +87 -0
  212. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +13 -0
  213. package/docs/variables/EventBusName.md +13 -0
  214. package/docs/variables/EventName.md +13 -0
  215. package/docs/variables/FilenameReservedRegex.md +16 -0
  216. package/docs/variables/HFBuiltins.md +92 -0
  217. package/docs/variables/InternalErrorCode.md +13 -0
  218. package/docs/variables/NotFoundErrorCode.md +13 -0
  219. package/docs/variables/NotImplementedErrorCode.md +13 -0
  220. package/docs/variables/PASSING_SCORE.md +13 -0
  221. package/docs/variables/PromptTemplateTypes.md +13 -0
  222. package/docs/variables/PromptTypes.md +16 -0
  223. package/docs/variables/RStreamErrCode.md +13 -0
  224. package/docs/variables/RemoteToolFuncSchema.md +87 -0
  225. package/docs/variables/ResponseRStreamErrCode.md +13 -0
  226. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +13 -0
  227. package/docs/variables/ServerToolFuncSchema.md +87 -0
  228. package/docs/variables/ToolAsyncCancelableBit.md +13 -0
  229. package/docs/variables/ToolAsyncMultiTaskBit.md +13 -0
  230. package/docs/variables/ToolAsyncPriorityBit.md +13 -0
  231. package/docs/variables/ToolFuncSchema.md +125 -0
  232. package/docs/variables/WindowsReservedNameRegex.md +15 -0
  233. package/docs/variables/base32768.md +13 -0
  234. package/docs/variables/defaultTemplateFormat.md +13 -0
  235. package/docs/variables/event.md +13 -0
  236. package/docs/variables/eventClient.md +13 -0
  237. package/docs/variables/eventServer.md +13 -0
  238. package/docs/variables/lrucache.md +13 -0
  239. package/docs/variables/mimeType.md +13 -0
  240. package/docs/variables/uuidNIL.md +13 -0
  241. package/package.json +26 -27
  242. package/dist/chunk-W2LO3HZT.mjs +0 -1
  243. package/docs/.nojekyll +0 -1
  244. package/docs/enums/AsyncFeatureBits.md +0 -41
  245. package/docs/enums/AsyncFeatures.md +0 -41
  246. package/docs/enums/ErrorCode.md +0 -239
  247. package/docs/enums/XXHashAlgorithm.md +0 -30
  248. package/docs/modules.md +0 -4062
package/docs/interfaces/ResServerFuncParams.md CHANGED
@@ -1,81 +1,73 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ResServerFuncParams
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: ResServerFuncParams
4
-
5
- ## Hierarchy
6
-
7
- - `RpcMethodsServerFuncParams`
3
+ ***
8
4
 
9
- ↳ **`ResServerFuncParams`**
5
+ [@isdk/ai-tool](../globals.md) / ResServerFuncParams
10
6
 
11
- ## Table of contents
7
+ # Interface: ResServerFuncParams
12
8
 
13
- ### Properties
9
+ ## Extends
14
10
 
15
- - [\_req](ResServerFuncParams.md#_req)
16
- - [\_res](ResServerFuncParams.md#_res)
17
- - [act](ResServerFuncParams.md#act)
18
- - [id](ResServerFuncParams.md#id)
19
- - [val](ResServerFuncParams.md#val)
11
+ - `RpcMethodsServerFuncParams`
20
12
 
21
13
  ## Properties
22
14
 
23
- ### \_req
15
+ ### \_req?
24
16
 
25
- • `Optional` **\_req**: `IncomingMessage`
17
+ > `optional` **\_req**: `IncomingMessage`
26
18
 
27
19
  #### Inherited from
28
20
 
29
- RpcMethodsServerFuncParams.\_req
21
+ `RpcMethodsServerFuncParams._req`
30
22
 
31
23
  #### Defined in
32
24
 
33
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L9)
25
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L9)
34
26
 
35
- ___
27
+ ***
36
28
 
37
- ### \_res
29
+ ### \_res?
38
30
 
39
- • `Optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
31
+ > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
40
32
 
41
33
  #### Inherited from
42
34
 
43
- RpcMethodsServerFuncParams.\_res
35
+ `RpcMethodsServerFuncParams._res`
44
36
 
45
37
  #### Defined in
46
38
 
47
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L10)
39
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L10)
48
40
 
49
- ___
41
+ ***
50
42
 
51
- ### act
43
+ ### act?
52
44
 
53
- • `Optional` **act**: `string`
45
+ > `optional` **act**: `string`
54
46
 
55
47
  #### Inherited from
56
48
 
57
- RpcMethodsServerFuncParams.act
49
+ `RpcMethodsServerFuncParams.act`
58
50
 
59
51
  #### Defined in
60
52
 
61
- [packages/ai-tool/src/rpc-methods-server-tool.ts:7](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/rpc-methods-server-tool.ts#L7)
53
+ [packages/ai-tool/src/rpc-methods-server-tool.ts:7](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/rpc-methods-server-tool.ts#L7)
62
54
 
63
- ___
55
+ ***
64
56
 
65
- ### id
57
+ ### id?
66
58
 
67
- • `Optional` **id**: `string` \| `number`
59
+ > `optional` **id**: `string` \| `number`
68
60
 
69
61
  #### Defined in
70
62
 
71
- [packages/ai-tool/src/res-server-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/res-server-tools.ts#L6)
63
+ [packages/ai-tool/src/res-server-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/res-server-tools.ts#L6)
72
64
 
73
- ___
65
+ ***
74
66
 
75
- ### val
67
+ ### val?
76
68
 
77
- • `Optional` **val**: `any`
69
+ > `optional` **val**: `any`
78
70
 
79
71
  #### Defined in
80
72
 
81
- [packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/res-server-tools.ts#L8)
73
+ [packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/res-server-tools.ts#L8)
package/docs/interfaces/SanitizeFilenameOptions.md CHANGED
@@ -1,30 +1,27 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / SanitizeFilenameOptions
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: SanitizeFilenameOptions
4
-
5
- ## Table of contents
3
+ ***
6
4
 
7
- ### Properties
5
+ [@isdk/ai-tool](../globals.md) / SanitizeFilenameOptions
8
6
 
9
- - [maxLength](SanitizeFilenameOptions.md#maxlength)
10
- - [replacement](SanitizeFilenameOptions.md#replacement)
7
+ # Interface: SanitizeFilenameOptions
11
8
 
12
9
  ## Properties
13
10
 
14
- ### maxLength
11
+ ### maxLength?
15
12
 
16
- • `Optional` **maxLength**: `number`
13
+ > `optional` **maxLength**: `number`
17
14
 
18
15
  #### Defined in
19
16
 
20
- [packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/filename.ts#L85)
17
+ [packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L85)
21
18
 
22
- ___
19
+ ***
23
20
 
24
- ### replacement
21
+ ### replacement?
25
22
 
26
- • `Optional` **replacement**: `string`
23
+ > `optional` **replacement**: `string`
27
24
 
28
25
  #### Defined in
29
26
 
30
- [packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/filename.ts#L84)
27
+ [packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L84)
package/docs/interfaces/ServerFuncItem.md CHANGED
@@ -1,207 +1,189 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ServerFuncItem
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: ServerFuncItem
4
-
5
- ## Hierarchy
3
+ ***
6
4
 
7
- - [`RemoteFuncItem`](RemoteFuncItem.md)
5
+ [@isdk/ai-tool](../globals.md) / ServerFuncItem
8
6
 
9
- ↳ **`ServerFuncItem`**
7
+ # Interface: ServerFuncItem
10
8
 
11
- ↳↳ [`ServerTools`](../classes/ServerTools.md)
9
+ ## Extends
12
10
 
13
- ## Table of contents
11
+ - [`RemoteFuncItem`](RemoteFuncItem.md)
14
12
 
15
- ### Properties
13
+ ## Extended by
16
14
 
17
- - [action](ServerFuncItem.md#action)
18
- - [allowExportFunc](ServerFuncItem.md#allowexportfunc)
19
- - [apiRoot](ServerFuncItem.md#apiroot)
20
- - [fetchOptions](ServerFuncItem.md#fetchoptions)
21
- - [isApi](ServerFuncItem.md#isapi)
22
- - [name](ServerFuncItem.md#name)
23
- - [params](ServerFuncItem.md#params)
24
- - [result](ServerFuncItem.md#result)
25
- - [scope](ServerFuncItem.md#scope)
26
- - [setup](ServerFuncItem.md#setup)
27
- - [stream](ServerFuncItem.md#stream)
28
- - [tags](ServerFuncItem.md#tags)
15
+ - [`ServerTools`](../classes/ServerTools.md)
29
16
 
30
17
  ## Properties
31
18
 
32
- ### action
19
+ ### action?
33
20
 
34
- • `Optional` **action**: ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"``
21
+ > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
35
22
 
36
23
  #### Inherited from
37
24
 
38
- [RemoteFuncItem](RemoteFuncItem.md).[action](RemoteFuncItem.md#action)
25
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
39
26
 
40
27
  #### Defined in
41
28
 
42
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/consts.ts#L35)
29
+ [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L35)
43
30
 
44
- ___
31
+ ***
45
32
 
46
- ### allowExportFunc
33
+ ### allowExportFunc?
47
34
 
48
- • `Optional` **allowExportFunc**: `boolean`
35
+ > `optional` **allowExportFunc**: `boolean`
49
36
 
50
37
  #### Defined in
51
38
 
52
- [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L14)
39
+ [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L14)
53
40
 
54
- ___
41
+ ***
55
42
 
56
- ### apiRoot
43
+ ### apiRoot?
57
44
 
58
- • `Optional` **apiRoot**: `string`
45
+ > `optional` **apiRoot**: `string`
59
46
 
60
47
  #### Inherited from
61
48
 
62
- [RemoteFuncItem](RemoteFuncItem.md).[apiRoot](RemoteFuncItem.md#apiroot)
49
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
63
50
 
64
51
  #### Defined in
65
52
 
66
- [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/consts.ts#L34)
53
+ [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L34)
67
54
 
68
- ___
55
+ ***
69
56
 
70
- ### fetchOptions
57
+ ### fetchOptions?
71
58
 
72
- • `Optional` **fetchOptions**: `any`
59
+ > `optional` **fetchOptions**: `any`
73
60
 
74
61
  #### Inherited from
75
62
 
76
- [RemoteFuncItem](RemoteFuncItem.md).[fetchOptions](RemoteFuncItem.md#fetchoptions)
63
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
77
64
 
78
65
  #### Defined in
79
66
 
80
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/consts.ts#L36)
67
+ [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L36)
81
68
 
82
- ___
69
+ ***
83
70
 
84
- ### isApi
71
+ ### isApi?
85
72
 
86
- • `Optional` **isApi**: `boolean`
73
+ > `optional` **isApi**: `boolean`
87
74
 
88
75
  #### Inherited from
89
76
 
90
- [RemoteFuncItem](RemoteFuncItem.md).[isApi](RemoteFuncItem.md#isapi)
77
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
91
78
 
92
79
  #### Defined in
93
80
 
94
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L47)
81
+ [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L47)
95
82
 
96
- ___
83
+ ***
97
84
 
98
- ### name
85
+ ### name?
99
86
 
100
- • `Optional` **name**: `string`
87
+ > `optional` **name**: `string`
101
88
 
102
89
  #### Inherited from
103
90
 
104
- [RemoteFuncItem](RemoteFuncItem.md).[name](RemoteFuncItem.md#name)
91
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
105
92
 
106
93
  #### Defined in
107
94
 
108
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L41)
95
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L41)
109
96
 
110
- ___
97
+ ***
111
98
 
112
- ### params
99
+ ### params?
113
100
 
114
- • `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
101
+ > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
115
102
 
116
103
  #### Inherited from
117
104
 
118
- [RemoteFuncItem](RemoteFuncItem.md).[params](RemoteFuncItem.md#params)
105
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
119
106
 
120
107
  #### Defined in
121
108
 
122
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L42)
109
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L42)
123
110
 
124
- ___
111
+ ***
125
112
 
126
- ### result
113
+ ### result?
127
114
 
128
- • `Optional` **result**: `string`
115
+ > `optional` **result**: `string`
129
116
 
130
117
  #### Inherited from
131
118
 
132
- [RemoteFuncItem](RemoteFuncItem.md).[result](RemoteFuncItem.md#result)
119
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
133
120
 
134
121
  #### Defined in
135
122
 
136
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L43)
123
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L43)
137
124
 
138
- ___
125
+ ***
139
126
 
140
- ### scope
127
+ ### scope?
141
128
 
142
- • `Optional` **scope**: `any`
129
+ > `optional` **scope**: `any`
143
130
 
144
131
  #### Inherited from
145
132
 
146
- [RemoteFuncItem](RemoteFuncItem.md).[scope](RemoteFuncItem.md#scope)
133
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
147
134
 
148
135
  #### Defined in
149
136
 
150
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L44)
151
-
152
- ___
137
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L44)
153
138
 
154
- ### setup
139
+ ***
155
140
 
156
- • `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
141
+ ### setup()?
157
142
 
158
- #### Type declaration
143
+ > `optional` **setup**: (`this`, `options`?) => `void`
159
144
 
160
- ▸ (`this`, `options?`): `void`
145
+ #### Parameters
161
146
 
162
- ##### Parameters
147
+ • **this**: [`ToolFunc`](../classes/ToolFunc.md)
163
148
 
164
- | Name | Type |
165
- | :------ | :------ |
166
- | `this` | [`ToolFunc`](../classes/ToolFunc.md) |
167
- | `options?` | [`FuncItem`](FuncItem.md) |
149
+ • **options?**: [`FuncItem`](FuncItem.md)
168
150
 
169
- ##### Returns
151
+ #### Returns
170
152
 
171
153
  `void`
172
154
 
173
155
  #### Inherited from
174
156
 
175
- [RemoteFuncItem](RemoteFuncItem.md).[setup](RemoteFuncItem.md#setup)
157
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
176
158
 
177
159
  #### Defined in
178
160
 
179
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L46)
161
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L46)
180
162
 
181
- ___
163
+ ***
182
164
 
183
- ### stream
165
+ ### stream?
184
166
 
185
- • `Optional` **stream**: `boolean`
167
+ > `optional` **stream**: `boolean`
186
168
 
187
169
  #### Inherited from
188
170
 
189
- [RemoteFuncItem](RemoteFuncItem.md).[stream](RemoteFuncItem.md#stream)
171
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
190
172
 
191
173
  #### Defined in
192
174
 
193
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L48)
175
+ [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L48)
194
176
 
195
- ___
177
+ ***
196
178
 
197
- ### tags
179
+ ### tags?
198
180
 
199
- • `Optional` **tags**: `string` \| `string`[]
181
+ > `optional` **tags**: `string` \| `string`[]
200
182
 
201
183
  #### Inherited from
202
184
 
203
- [RemoteFuncItem](RemoteFuncItem.md).[tags](RemoteFuncItem.md#tags)
185
+ [`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)
204
186
 
205
187
  #### Defined in
206
188
 
207
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L45)
189
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L45)
package/docs/interfaces/ServerFuncParams.md CHANGED
@@ -1,42 +1,37 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ServerFuncParams
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ServerFuncParams
2
6
 
3
7
  # Interface: ServerFuncParams
4
8
 
5
9
  Convention: Always pass _req, _res
6
10
 
7
- ## Hierarchy
8
-
9
- - **`ServerFuncParams`**
11
+ ## Extended by
10
12
 
11
- ↳ [`EventServerFuncParams`](EventServerFuncParams.md)
13
+ - [`EventServerFuncParams`](EventServerFuncParams.md)
12
14
 
13
15
  ## Indexable
14
16
 
15
- ▪ [name: `string`]: `any`
16
-
17
- ## Table of contents
18
-
19
- ### Properties
20
-
21
- - [\_req](ServerFuncParams.md#_req)
22
- - [\_res](ServerFuncParams.md#_res)
17
+ \[`name`: `string`\]: `any`
23
18
 
24
19
  ## Properties
25
20
 
26
- ### \_req
21
+ ### \_req?
27
22
 
28
- • `Optional` **\_req**: `IncomingMessage`
23
+ > `optional` **\_req**: `IncomingMessage`
29
24
 
30
25
  #### Defined in
31
26
 
32
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L9)
27
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L9)
33
28
 
34
- ___
29
+ ***
35
30
 
36
- ### \_res
31
+ ### \_res?
37
32
 
38
- • `Optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
33
+ > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
39
34
 
40
35
  #### Defined in
41
36
 
42
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/server-tools.ts#L10)
37
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L10)
package/docs/interfaces/StreamCallbacksAndOptions.md CHANGED
@@ -1,124 +1,95 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / StreamCallbacksAndOptions
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: StreamCallbacksAndOptions\<I, O\>
3
+ ***
4
4
 
5
- Configuration options and helper callback methods for stream lifecycle events.
5
+ [@isdk/ai-tool](../globals.md) / StreamCallbacksAndOptions
6
6
 
7
- ## Type parameters
7
+ # Interface: StreamCallbacksAndOptions\<I, O\>
8
8
 
9
- | Name | Type |
10
- | :------ | :------ |
11
- | `I` | `any` |
12
- | `O` | `any` |
9
+ Configuration options and helper callback methods for stream lifecycle events.
13
10
 
14
- ## Table of contents
11
+ ## Type Parameters
15
12
 
16
- ### Properties
13
+ • **I** = `any`
17
14
 
18
- - [onError](StreamCallbacksAndOptions.md#onerror)
19
- - [onFinal](StreamCallbacksAndOptions.md#onfinal)
20
- - [onStart](StreamCallbacksAndOptions.md#onstart)
21
- - [onTransform](StreamCallbacksAndOptions.md#ontransform)
15
+ • **O** = `any`
22
16
 
23
17
  ## Properties
24
18
 
25
- ### onError
26
-
27
- • `Optional` **onError**: (`error`: `Error`) => `void` \| `Promise`\<`void`\>
28
-
29
- #### Type declaration
19
+ ### onError()?
30
20
 
31
- ▸ (`error`): `void` \| `Promise`\<`void`\>
21
+ > `optional` **onError**: (`error`) => `void` \| `Promise`\<`void`\>
32
22
 
33
- ##### Parameters
23
+ #### Parameters
34
24
 
35
- | Name | Type |
36
- | :------ | :------ |
37
- | `error` | `Error` |
25
+ • **error**: `Error`
38
26
 
39
- ##### Returns
27
+ #### Returns
40
28
 
41
29
  `void` \| `Promise`\<`void`\>
42
30
 
43
31
  #### Defined in
44
32
 
45
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/stream/create-callbacks-stream.ts#L12)
33
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/create-callbacks-stream.ts#L12)
46
34
 
47
- ___
35
+ ***
48
36
 
49
- ### onFinal
37
+ ### onFinal()?
50
38
 
51
- • `Optional` **onFinal**: (`controller`: `TransformStreamDefaultController`\<`any`\>) => `void` \| `Promise`\<`void`\>
39
+ > `optional` **onFinal**: (`controller`) => `void` \| `Promise`\<`void`\>
52
40
 
53
41
  `onFinal`: Called once when the stream is closed with the final completion message.
54
42
 
55
- #### Type declaration
43
+ #### Parameters
56
44
 
57
- ▸ (`controller`): `void` \| `Promise`\<`void`\>
45
+ • **controller**: `TransformStreamDefaultController`\<`any`\>
58
46
 
59
- ##### Parameters
60
-
61
- | Name | Type |
62
- | :------ | :------ |
63
- | `controller` | `TransformStreamDefaultController`\<`any`\> |
64
-
65
- ##### Returns
47
+ #### Returns
66
48
 
67
49
  `void` \| `Promise`\<`void`\>
68
50
 
69
51
  #### Defined in
70
52
 
71
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/stream/create-callbacks-stream.ts#L11)
53
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/create-callbacks-stream.ts#L11)
72
54
 
73
- ___
55
+ ***
74
56
 
75
- ### onStart
57
+ ### onStart()?
76
58
 
77
- • `Optional` **onStart**: (`controller`: `TransformStreamDefaultController`\<`any`\>) => `void` \| `Promise`\<`void`\>
59
+ > `optional` **onStart**: (`controller`) => `void` \| `Promise`\<`void`\>
78
60
 
79
61
  `onStart`: Called once when the stream is initialized.
80
62
 
81
- #### Type declaration
82
-
83
- ▸ (`controller`): `void` \| `Promise`\<`void`\>
63
+ #### Parameters
84
64
 
85
- ##### Parameters
65
+ • **controller**: `TransformStreamDefaultController`\<`any`\>
86
66
 
87
- | Name | Type |
88
- | :------ | :------ |
89
- | `controller` | `TransformStreamDefaultController`\<`any`\> |
90
-
91
- ##### Returns
67
+ #### Returns
92
68
 
93
69
  `void` \| `Promise`\<`void`\>
94
70
 
95
71
  #### Defined in
96
72
 
97
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/stream/create-callbacks-stream.ts#L7)
73
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/create-callbacks-stream.ts#L7)
98
74
 
99
- ___
75
+ ***
100
76
 
101
- ### onTransform
77
+ ### onTransform()?
102
78
 
103
- • `Optional` **onTransform**: (`chunk`: `I`, `controller`: `TransformStreamDefaultController`\<`any`\>) => `void` \| `O` \| `Promise`\<`void` \| `O`\>
79
+ > `optional` **onTransform**: (`chunk`, `controller`) => `void` \| `O` \| `Promise`\<`void` \| `O`\>
104
80
 
105
81
  `onToken`: Called for each tokenized message.
106
82
 
107
- #### Type declaration
108
-
109
- ▸ (`chunk`, `controller`): `void` \| `O` \| `Promise`\<`void` \| `O`\>
83
+ #### Parameters
110
84
 
111
- ##### Parameters
85
+ • **chunk**: `I`
112
86
 
113
- | Name | Type |
114
- | :------ | :------ |
115
- | `chunk` | `I` |
116
- | `controller` | `TransformStreamDefaultController`\<`any`\> |
87
+ • **controller**: `TransformStreamDefaultController`\<`any`\>
117
88
 
118
- ##### Returns
89
+ #### Returns
119
90
 
120
91
  `void` \| `O` \| `Promise`\<`void` \| `O`\>
121
92
 
122
93
  #### Defined in
123
94
 
124
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/stream/create-callbacks-stream.ts#L9)
95
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/create-callbacks-stream.ts#L9)
package/docs/interfaces/TaskAbortControllers.md CHANGED
@@ -1,7 +1,11 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / TaskAbortControllers
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / TaskAbortControllers
2
6
 
3
7
  # Interface: TaskAbortControllers
4
8
 
5
9
  ## Indexable
6
10
 
7
- ▪ [k: [`AsyncTaskId`](../modules.md#asynctaskid)]: [`TaskAbortController`](../classes/TaskAbortController.md) \| `undefined`
11
+ \[`k`: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)\]: [`TaskAbortController`](../classes/TaskAbortController.md) \| `undefined`