@isdk/ai-tool 0.0.6 → 0.0.8

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 (85) hide show
  1. package/dist/chunk-B7IE5ATQ.mjs +1 -0
  2. package/dist/chunk-U5DDQYSF.mjs +1 -22
  3. package/dist/funcs.d.mts +2 -2
  4. package/dist/funcs.d.ts +2 -2
  5. package/dist/funcs.js +1 -5020
  6. package/dist/funcs.mjs +1 -37
  7. package/dist/{index-D4KjfAKl.d.mts → index-Dgo3ZXPQ.d.mts} +29 -14
  8. package/dist/{index-D4KjfAKl.d.ts → index-Dgo3ZXPQ.d.ts} +29 -14
  9. package/dist/index.d.mts +372 -56
  10. package/dist/index.d.ts +372 -56
  11. package/dist/index.js +1 -5245
  12. package/dist/index.mjs +1 -402
  13. package/dist/test/util.js +1 -97
  14. package/dist/test/util.mjs +1 -60
  15. package/docs/classes/AbortError.md +8 -8
  16. package/docs/classes/AlreadyExistsError.md +8 -8
  17. package/docs/classes/BaseError.md +8 -8
  18. package/docs/classes/CancelableAbility.md +431 -0
  19. package/docs/classes/ClientTools.md +101 -51
  20. package/docs/classes/CommonError.md +8 -8
  21. package/docs/classes/EventClient.md +123 -73
  22. package/docs/classes/EventServer.md +121 -71
  23. package/docs/classes/EventToolFunc.md +91 -41
  24. package/docs/classes/FStringPromptTemplate.md +18 -18
  25. package/docs/classes/FewShotPromptTemplate.md +22 -22
  26. package/docs/classes/GolangPromptTemplate.md +18 -18
  27. package/docs/classes/HFEnvironment.md +9 -9
  28. package/docs/classes/HFInterpreter.md +17 -17
  29. package/docs/classes/HFTemplate.md +4 -4
  30. package/docs/classes/HfPromptTemplate.md +18 -18
  31. package/docs/classes/IntSet.md +249 -0
  32. package/docs/classes/NotFoundError.md +8 -8
  33. package/docs/classes/NotImplementationError.md +8 -8
  34. package/docs/classes/PromptExampleSelector.md +8 -8
  35. package/docs/classes/PromptTemplate.md +17 -17
  36. package/docs/classes/ReadableStreamError.md +8 -8
  37. package/docs/classes/ResClientTools.md +107 -57
  38. package/docs/classes/ResServerTools.md +105 -55
  39. package/docs/classes/SSEChannel.md +15 -15
  40. package/docs/classes/Semaphore.md +273 -0
  41. package/docs/classes/ServerTools.md +98 -48
  42. package/docs/classes/TaskAbortController.md +157 -0
  43. package/docs/classes/ToolFunc.md +80 -38
  44. package/docs/enums/AsyncFeatureBits.md +41 -0
  45. package/docs/enums/AsyncFeatures.md +41 -0
  46. package/docs/enums/ErrorCode.md +41 -19
  47. package/docs/enums/XXHashAlgorithm.md +2 -2
  48. package/docs/interfaces/AIChatAssistantMessageParam.md +6 -6
  49. package/docs/interfaces/AIChatContentPartImage.md +2 -2
  50. package/docs/interfaces/AIChatContentPartText.md +2 -2
  51. package/docs/interfaces/AIChatMessageParamBase.md +1 -1
  52. package/docs/interfaces/AIChatMessageToolCall.md +3 -3
  53. package/docs/interfaces/AIChatSystemMessageParam.md +3 -3
  54. package/docs/interfaces/AIChatToolMessageParam.md +4 -4
  55. package/docs/interfaces/AIChatUserMessageParam.md +7 -7
  56. package/docs/interfaces/AIResult.md +16 -5
  57. package/docs/interfaces/AIStreamParser.md +1 -1
  58. package/docs/interfaces/AIStreamParserOptions.md +1 -1
  59. package/docs/interfaces/BaseFunc.md +7 -7
  60. package/docs/interfaces/BaseFuncItem.md +6 -6
  61. package/docs/interfaces/CancelableAbilityOptions.md +126 -0
  62. package/docs/interfaces/ClientFuncItem.md +10 -10
  63. package/docs/interfaces/DotenvExpandOptions.md +3 -3
  64. package/docs/interfaces/DotenvExpandOutput.md +2 -2
  65. package/docs/interfaces/EventClientFuncParams.md +4 -4
  66. package/docs/interfaces/EventServerFuncParams.md +5 -5
  67. package/docs/interfaces/FewShotPromptTemplateOptions.md +11 -11
  68. package/docs/interfaces/FuncItem.md +7 -7
  69. package/docs/interfaces/FuncParam.md +16 -5
  70. package/docs/interfaces/PromptExampleSelectorOptions.md +2 -2
  71. package/docs/interfaces/PromptTemplateOptions.md +6 -6
  72. package/docs/interfaces/RemoteFuncItem.md +10 -10
  73. package/docs/interfaces/ResClientFuncParams.md +2 -2
  74. package/docs/interfaces/ResServerFuncParams.md +5 -5
  75. package/docs/interfaces/SanitizeFilenameOptions.md +2 -2
  76. package/docs/interfaces/ServerFuncItem.md +11 -11
  77. package/docs/interfaces/ServerFuncParams.md +2 -2
  78. package/docs/interfaces/StreamCallbacksAndOptions.md +124 -0
  79. package/docs/interfaces/TaskAbortControllers.md +7 -0
  80. package/docs/interfaces/TaskPromise.md +151 -0
  81. package/docs/interfaces/ToolFuncPackage.md +63 -0
  82. package/docs/modules.md +1156 -225
  83. package/package.json +5 -6
  84. package/dist/chunk-6AXCY6TJ.mjs +0 -5090
  85. package/docs/interfaces/AIStreamCallbacksAndOptions.md +0 -158
package/docs/interfaces/RemoteFuncItem.md CHANGED
@@ -35,7 +35,7 @@
35
35
 
36
36
  #### Defined in
37
37
 
38
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L36)
38
+ [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L36)
39
39
 
40
40
  ___
41
41
 
@@ -45,7 +45,7 @@ ___
45
45
 
46
46
  #### Defined in
47
47
 
48
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L35)
48
+ [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L35)
49
49
 
50
50
  ___
51
51
 
@@ -55,7 +55,7 @@ ___
55
55
 
56
56
  #### Defined in
57
57
 
58
- [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L37)
58
+ [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L37)
59
59
 
60
60
  ___
61
61
 
@@ -69,7 +69,7 @@ ___
69
69
 
70
70
  #### Defined in
71
71
 
72
- [packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L21)
72
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L41)
73
73
 
74
74
  ___
75
75
 
@@ -83,7 +83,7 @@ ___
83
83
 
84
84
  #### Defined in
85
85
 
86
- [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L22)
86
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L42)
87
87
 
88
88
  ___
89
89
 
@@ -97,7 +97,7 @@ ___
97
97
 
98
98
  #### Defined in
99
99
 
100
- [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L23)
100
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L43)
101
101
 
102
102
  ___
103
103
 
@@ -111,7 +111,7 @@ ___
111
111
 
112
112
  #### Defined in
113
113
 
114
- [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L24)
114
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L44)
115
115
 
116
116
  ___
117
117
 
@@ -140,7 +140,7 @@ ___
140
140
 
141
141
  #### Defined in
142
142
 
143
- [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L26)
143
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L46)
144
144
 
145
145
  ___
146
146
 
@@ -150,7 +150,7 @@ ___
150
150
 
151
151
  #### Defined in
152
152
 
153
- [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L38)
153
+ [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L38)
154
154
 
155
155
  ___
156
156
 
@@ -164,4 +164,4 @@ ___
164
164
 
165
165
  #### Defined in
166
166
 
167
- [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L25)
167
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L45)
package/docs/interfaces/ResClientFuncParams.md CHANGED
@@ -21,7 +21,7 @@
21
21
 
22
22
  #### Defined in
23
23
 
24
- [packages/ai-tool/src/res-client-tools.ts:7](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/res-client-tools.ts#L7)
24
+ [packages/ai-tool/src/res-client-tools.ts:7](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/res-client-tools.ts#L7)
25
25
 
26
26
  ___
27
27
 
@@ -31,4 +31,4 @@ ___
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/res-client-tools.ts#L6)
34
+ [packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/res-client-tools.ts#L6)
package/docs/interfaces/ResServerFuncParams.md CHANGED
@@ -32,7 +32,7 @@ Convention: Always pass _req, _res
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/server-tools.ts#L9)
35
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L9)
36
36
 
37
37
  ___
38
38
 
@@ -46,7 +46,7 @@ ___
46
46
 
47
47
  #### Defined in
48
48
 
49
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/server-tools.ts#L10)
49
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L10)
50
50
 
51
51
  ___
52
52
 
@@ -56,7 +56,7 @@ ___
56
56
 
57
57
  #### Defined in
58
58
 
59
- [packages/ai-tool/src/res-server-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/res-server-tools.ts#L11)
59
+ [packages/ai-tool/src/res-server-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/res-server-tools.ts#L11)
60
60
 
61
61
  ___
62
62
 
@@ -66,7 +66,7 @@ ___
66
66
 
67
67
  #### Defined in
68
68
 
69
- [packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/res-server-tools.ts#L8)
69
+ [packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/res-server-tools.ts#L8)
70
70
 
71
71
  ___
72
72
 
@@ -76,4 +76,4 @@ ___
76
76
 
77
77
  #### Defined in
78
78
 
79
- [packages/ai-tool/src/res-server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/res-server-tools.ts#L10)
79
+ [packages/ai-tool/src/res-server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/res-server-tools.ts#L10)
package/docs/interfaces/SanitizeFilenameOptions.md CHANGED
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/filename.ts#L85)
20
+ [packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/filename.ts#L85)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/filename.ts#L84)
30
+ [packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/filename.ts#L84)
package/docs/interfaces/ServerFuncItem.md CHANGED
@@ -38,7 +38,7 @@
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L36)
41
+ [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L36)
42
42
 
43
43
  ___
44
44
 
@@ -48,7 +48,7 @@ ___
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/server-tools.ts#L14)
51
+ [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L14)
52
52
 
53
53
  ___
54
54
 
@@ -62,7 +62,7 @@ ___
62
62
 
63
63
  #### Defined in
64
64
 
65
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L35)
65
+ [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L35)
66
66
 
67
67
  ___
68
68
 
@@ -76,7 +76,7 @@ ___
76
76
 
77
77
  #### Defined in
78
78
 
79
- [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L37)
79
+ [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L37)
80
80
 
81
81
  ___
82
82
 
@@ -90,7 +90,7 @@ ___
90
90
 
91
91
  #### Defined in
92
92
 
93
- [packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L21)
93
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L41)
94
94
 
95
95
  ___
96
96
 
@@ -104,7 +104,7 @@ ___
104
104
 
105
105
  #### Defined in
106
106
 
107
- [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L22)
107
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L42)
108
108
 
109
109
  ___
110
110
 
@@ -118,7 +118,7 @@ ___
118
118
 
119
119
  #### Defined in
120
120
 
121
- [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L23)
121
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L43)
122
122
 
123
123
  ___
124
124
 
@@ -132,7 +132,7 @@ ___
132
132
 
133
133
  #### Defined in
134
134
 
135
- [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L24)
135
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L44)
136
136
 
137
137
  ___
138
138
 
@@ -161,7 +161,7 @@ ___
161
161
 
162
162
  #### Defined in
163
163
 
164
- [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L26)
164
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L46)
165
165
 
166
166
  ___
167
167
 
@@ -175,7 +175,7 @@ ___
175
175
 
176
176
  #### Defined in
177
177
 
178
- [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/utils/consts.ts#L38)
178
+ [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L38)
179
179
 
180
180
  ___
181
181
 
@@ -189,4 +189,4 @@ ___
189
189
 
190
190
  #### Defined in
191
191
 
192
- [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/tool-func.ts#L25)
192
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L45)
package/docs/interfaces/ServerFuncParams.md CHANGED
@@ -31,7 +31,7 @@ Convention: Always pass _req, _res
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/server-tools.ts#L9)
34
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L9)
35
35
 
36
36
  ___
37
37
 
@@ -41,4 +41,4 @@ ___
41
41
 
42
42
  #### Defined in
43
43
 
44
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c377a1408daee78a2484142b6d99ef7fbbec7c7c/src/server-tools.ts#L10)
44
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L10)
package/docs/interfaces/StreamCallbacksAndOptions.md ADDED
@@ -0,0 +1,124 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / StreamCallbacksAndOptions
2
+
3
+ # Interface: StreamCallbacksAndOptions\<I, O\>
4
+
5
+ Configuration options and helper callback methods for stream lifecycle events.
6
+
7
+ ## Type parameters
8
+
9
+ | Name | Type |
10
+ | :------ | :------ |
11
+ | `I` | `any` |
12
+ | `O` | `any` |
13
+
14
+ ## Table of contents
15
+
16
+ ### Properties
17
+
18
+ - [onError](StreamCallbacksAndOptions.md#onerror)
19
+ - [onFinal](StreamCallbacksAndOptions.md#onfinal)
20
+ - [onStart](StreamCallbacksAndOptions.md#onstart)
21
+ - [onTransform](StreamCallbacksAndOptions.md#ontransform)
22
+
23
+ ## Properties
24
+
25
+ ### onError
26
+
27
+ • `Optional` **onError**: (`error`: `Error`) => `void` \| `Promise`\<`void`\>
28
+
29
+ #### Type declaration
30
+
31
+ ▸ (`error`): `void` \| `Promise`\<`void`\>
32
+
33
+ ##### Parameters
34
+
35
+ | Name | Type |
36
+ | :------ | :------ |
37
+ | `error` | `Error` |
38
+
39
+ ##### Returns
40
+
41
+ `void` \| `Promise`\<`void`\>
42
+
43
+ #### Defined in
44
+
45
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/stream/create-callbacks-stream.ts#L12)
46
+
47
+ ___
48
+
49
+ ### onFinal
50
+
51
+ • `Optional` **onFinal**: (`controller`: `TransformStreamDefaultController`\<`any`\>) => `void` \| `Promise`\<`void`\>
52
+
53
+ `onFinal`: Called once when the stream is closed with the final completion message.
54
+
55
+ #### Type declaration
56
+
57
+ ▸ (`controller`): `void` \| `Promise`\<`void`\>
58
+
59
+ ##### Parameters
60
+
61
+ | Name | Type |
62
+ | :------ | :------ |
63
+ | `controller` | `TransformStreamDefaultController`\<`any`\> |
64
+
65
+ ##### Returns
66
+
67
+ `void` \| `Promise`\<`void`\>
68
+
69
+ #### Defined in
70
+
71
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/stream/create-callbacks-stream.ts#L11)
72
+
73
+ ___
74
+
75
+ ### onStart
76
+
77
+ • `Optional` **onStart**: (`controller`: `TransformStreamDefaultController`\<`any`\>) => `void` \| `Promise`\<`void`\>
78
+
79
+ `onStart`: Called once when the stream is initialized.
80
+
81
+ #### Type declaration
82
+
83
+ ▸ (`controller`): `void` \| `Promise`\<`void`\>
84
+
85
+ ##### Parameters
86
+
87
+ | Name | Type |
88
+ | :------ | :------ |
89
+ | `controller` | `TransformStreamDefaultController`\<`any`\> |
90
+
91
+ ##### Returns
92
+
93
+ `void` \| `Promise`\<`void`\>
94
+
95
+ #### Defined in
96
+
97
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/stream/create-callbacks-stream.ts#L7)
98
+
99
+ ___
100
+
101
+ ### onTransform
102
+
103
+ • `Optional` **onTransform**: (`chunk`: `I`, `controller`: `TransformStreamDefaultController`\<`any`\>) => `void` \| `O` \| `Promise`\<`void` \| `O`\>
104
+
105
+ `onToken`: Called for each tokenized message.
106
+
107
+ #### Type declaration
108
+
109
+ ▸ (`chunk`, `controller`): `void` \| `O` \| `Promise`\<`void` \| `O`\>
110
+
111
+ ##### Parameters
112
+
113
+ | Name | Type |
114
+ | :------ | :------ |
115
+ | `chunk` | `I` |
116
+ | `controller` | `TransformStreamDefaultController`\<`any`\> |
117
+
118
+ ##### Returns
119
+
120
+ `void` \| `O` \| `Promise`\<`void` \| `O`\>
121
+
122
+ #### Defined in
123
+
124
+ [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/stream/create-callbacks-stream.ts#L9)
package/docs/interfaces/TaskAbortControllers.md ADDED
@@ -0,0 +1,7 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / TaskAbortControllers
2
+
3
+ # Interface: TaskAbortControllers
4
+
5
+ ## Indexable
6
+
7
+ ▪ [k: [`AsyncTaskId`](../modules.md#asynctaskid)]: [`TaskAbortController`](../classes/TaskAbortController.md) \| `undefined`
package/docs/interfaces/TaskPromise.md ADDED
@@ -0,0 +1,151 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / TaskPromise
2
+
3
+ # Interface: TaskPromise\<T\>
4
+
5
+ ## Type parameters
6
+
7
+ | Name | Type |
8
+ | :------ | :------ |
9
+ | `T` | `any` |
10
+
11
+ ## Hierarchy
12
+
13
+ - `Promise`\<`T`\>
14
+
15
+ ↳ **`TaskPromise`**
16
+
17
+ ## Table of contents
18
+
19
+ ### Properties
20
+
21
+ - [[toStringTag]](TaskPromise.md#[tostringtag])
22
+ - [task](TaskPromise.md#task)
23
+
24
+ ### Methods
25
+
26
+ - [catch](TaskPromise.md#catch)
27
+ - [finally](TaskPromise.md#finally)
28
+ - [then](TaskPromise.md#then)
29
+
30
+ ## Properties
31
+
32
+ ### [toStringTag]
33
+
34
+ • `Readonly` **[toStringTag]**: `string`
35
+
36
+ #### Inherited from
37
+
38
+ Promise.[toStringTag]
39
+
40
+ #### Defined in
41
+
42
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:176
43
+
44
+ ___
45
+
46
+ ### task
47
+
48
+ • `Optional` **task**: [`TaskAbortController`](../classes/TaskAbortController.md)
49
+
50
+ #### Defined in
51
+
52
+ [packages/ai-tool/src/utils/cancelable-ability.ts:51](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L51)
53
+
54
+ ## Methods
55
+
56
+ ### catch
57
+
58
+ ▸ **catch**\<`TResult`\>(`onrejected?`): `Promise`\<`T` \| `TResult`\>
59
+
60
+ Attaches a callback for only the rejection of the Promise.
61
+
62
+ #### Type parameters
63
+
64
+ | Name | Type |
65
+ | :------ | :------ |
66
+ | `TResult` | `never` |
67
+
68
+ #### Parameters
69
+
70
+ | Name | Type | Description |
71
+ | :------ | :------ | :------ |
72
+ | `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult` \| `PromiseLike`\<`TResult`\> | The callback to execute when the Promise is rejected. |
73
+
74
+ #### Returns
75
+
76
+ `Promise`\<`T` \| `TResult`\>
77
+
78
+ A Promise for the completion of the callback.
79
+
80
+ #### Inherited from
81
+
82
+ Promise.catch
83
+
84
+ #### Defined in
85
+
86
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1557
87
+
88
+ ___
89
+
90
+ ### finally
91
+
92
+ ▸ **finally**(`onfinally?`): `Promise`\<`T`\>
93
+
94
+ Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
95
+ resolved value cannot be modified from the callback.
96
+
97
+ #### Parameters
98
+
99
+ | Name | Type | Description |
100
+ | :------ | :------ | :------ |
101
+ | `onfinally?` | ``null`` \| () => `void` | The callback to execute when the Promise is settled (fulfilled or rejected). |
102
+
103
+ #### Returns
104
+
105
+ `Promise`\<`T`\>
106
+
107
+ A Promise for the completion of the callback.
108
+
109
+ #### Inherited from
110
+
111
+ Promise.finally
112
+
113
+ #### Defined in
114
+
115
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2018.promise.d.ts:29
116
+
117
+ ___
118
+
119
+ ### then
120
+
121
+ ▸ **then**\<`TResult1`, `TResult2`\>(`onfulfilled?`, `onrejected?`): `Promise`\<`TResult1` \| `TResult2`\>
122
+
123
+ Attaches callbacks for the resolution and/or rejection of the Promise.
124
+
125
+ #### Type parameters
126
+
127
+ | Name | Type |
128
+ | :------ | :------ |
129
+ | `TResult1` | `T` |
130
+ | `TResult2` | `never` |
131
+
132
+ #### Parameters
133
+
134
+ | Name | Type | Description |
135
+ | :------ | :------ | :------ |
136
+ | `onfulfilled?` | ``null`` \| (`value`: `T`) => `TResult1` \| `PromiseLike`\<`TResult1`\> | The callback to execute when the Promise is resolved. |
137
+ | `onrejected?` | ``null`` \| (`reason`: `any`) => `TResult2` \| `PromiseLike`\<`TResult2`\> | The callback to execute when the Promise is rejected. |
138
+
139
+ #### Returns
140
+
141
+ `Promise`\<`TResult1` \| `TResult2`\>
142
+
143
+ A Promise for the completion of which ever callback is executed.
144
+
145
+ #### Inherited from
146
+
147
+ Promise.then
148
+
149
+ #### Defined in
150
+
151
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1550
package/docs/interfaces/ToolFuncPackage.md ADDED
@@ -0,0 +1,63 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ToolFuncPackage
2
+
3
+ # Interface: ToolFuncPackage
4
+
5
+ ## Table of contents
6
+
7
+ ### Properties
8
+
9
+ - [name](ToolFuncPackage.md#name)
10
+ - [register](ToolFuncPackage.md#register)
11
+ - [unregister](ToolFuncPackage.md#unregister)
12
+
13
+ ## Properties
14
+
15
+ ### name
16
+
17
+ • **name**: `string`
18
+
19
+ #### Defined in
20
+
21
+ [packages/ai-tool/src/tool-func.ts:62](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L62)
22
+
23
+ ___
24
+
25
+ ### register
26
+
27
+ • **register**: (`data?`: `any`) => `void`
28
+
29
+ #### Type declaration
30
+
31
+ ▸ (`data?`): `void`
32
+
33
+ ##### Parameters
34
+
35
+ | Name | Type |
36
+ | :------ | :------ |
37
+ | `data?` | `any` |
38
+
39
+ ##### Returns
40
+
41
+ `void`
42
+
43
+ #### Defined in
44
+
45
+ [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L63)
46
+
47
+ ___
48
+
49
+ ### unregister
50
+
51
+ • `Optional` **unregister**: () => `void`
52
+
53
+ #### Type declaration
54
+
55
+ ▸ (): `void`
56
+
57
+ ##### Returns
58
+
59
+ `void`
60
+
61
+ #### Defined in
62
+
63
+ [packages/ai-tool/src/tool-func.ts:64](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L64)