@isdk/ai-tool 0.8.2 → 0.9.0

package/docs/api/interfaces/RemoteFuncItem.md

@@ -6,7 +6,7 @@
 
 # Interface: RemoteFuncItem
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:83](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/consts.ts#L83)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:70
 
 Base interface for a remote function's configuration, extending `BaseFuncItem`
 with properties required for remote execution.
@@ -26,7 +26,7 @@ with properties required for remote execution.
 
 > `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/consts.ts#L95)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:82
 
 The action to be used for the remote call. This typically represents an RPC method name.
 Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
@@ -37,7 +37,7 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
 
 > `optional` **alias**: `string` \| `string`[]
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L130)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:258
 
 Optional aliases for the function name.
 
@@ -51,7 +51,7 @@ Optional aliases for the function name.
 
 > `optional` **apiRoot**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/consts.ts#L89)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:76
 
 The root endpoint for the remote service.
 
@@ -65,7 +65,7 @@ Use `transport` instead.
 
 > `optional` **asyncFeatures**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L144)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:272
 
 A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
 This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
@@ -95,7 +95,7 @@ const func = new ToolFunc({
 
 > `optional` **depends**: `object`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L167)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:295
 
 A map of dependencies this function has on other tool functions.
 Declaring dependencies ensures that they are automatically registered when this function is registered.
@@ -134,7 +134,7 @@ mainFunc.register();
 
 > `optional` **description**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L172)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:302
 
 A detailed description of what the function does.
 
@@ -144,11 +144,21 @@ A detailed description of what the function does.
 
 ***
 
+### expectedDuration?
+
+> `optional` **expectedDuration**: `number`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:102
+
+The expected duration of the remote call in milliseconds.
+
+***
+
 ### fetchOptions?
 
 > `optional` **fetchOptions**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/consts.ts#L100)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:87
 
 Addtional options to be passed to the underlying `fetch` call in a transport.
 
@@ -158,7 +168,7 @@ Addtional options to be passed to the underlying `fetch` call in a transport.
 
 > `optional` **isApi**: `boolean`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L119)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:247
 
 If true, indicates that this function should be treated as a server-side API.
 
@@ -172,7 +182,7 @@ If true, indicates that this function should be treated as a server-side API.
 
 > `optional` **name**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L76)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:204
 
 The unique name of the function.
 
@@ -186,7 +196,7 @@ The unique name of the function.
 
 > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L81)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:209
 
 Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
 
@@ -200,7 +210,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
 
 > `optional` **result**: `string` \| `Record`\<`string`, `any`\>
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L86)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:214
 
 The expected return type of the function, described as a string or a JSON schema object.
 
@@ -214,7 +224,7 @@ The expected return type of the function, described as a string or a JSON schema
 
 > `optional` **scope**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L91)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:219
 
 The execution scope or context (`this`) for the function.
 
@@ -228,7 +238,7 @@ The execution scope or context (`this`) for the function.
 
 > `optional` **setup**: (`this`, `options?`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L114)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:242
 
 A lifecycle hook called once during the `ToolFunc` instance's initialization.
 It allows for initial setup, state configuration, or property modification on the instance
@@ -274,12 +284,11 @@ console.log(myFunc.customState); // Outputs: 'configured'
 
 > `optional` **stream**: `boolean`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L125)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:106
 
-If true, indicates that the function has the *capability* to stream its output.
-Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
+Whether the tool returns a stream.
 
-#### Inherited from
+#### Overrides
 
 [`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
 
@@ -289,7 +298,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
 
 > `optional` **tags**: `string` \| `string`[]
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L96)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:224
 
 Tags for grouping or filtering functions.
 
@@ -299,11 +308,45 @@ Tags for grouping or filtering functions.
 
 ***
 
+### timeout?
+
+> `optional` **timeout**: `number` \| \{ `keepAliveOnTimeout?`: `boolean`; `streamIdleTimeout?`: `number`; `value`: `number`; \}
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:91
+
+The timeout configuration for the remote call.
+
+#### Type Declaration
+
+`number`
+
+\{ `keepAliveOnTimeout?`: `boolean`; `streamIdleTimeout?`: `number`; `value`: `number`; \}
+
+#### keepAliveOnTimeout?
+
+> `optional` **keepAliveOnTimeout**: `boolean`
+
+Whether to keep the server-side function running after a timeout.
+
+#### streamIdleTimeout?
+
+> `optional` **streamIdleTimeout**: `number`
+
+The idle timeout for streaming responses in milliseconds.
+
+#### value
+
+> **value**: `number`
+
+The hard timeout in milliseconds.
+
+***
+
 ### title?
 
 > `optional` **title**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/tool-func.ts#L177)
+Defined in: @isdk/ai-tools/packages/tool-func/dist/index.d.ts:307
 
 A concise, human-readable title for the function, often used in UI or by AI.
 

package/docs/api/interfaces/ReplacePlacehoderOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: ReplacePlacehoderOptions
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:464](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/parse-command.ts#L464)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:3](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L3)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:464](htt
 
 > `optional` **endChar**: `string` \| `string`[]
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:466](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/parse-command.ts#L466)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:5](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L5)
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:466](htt
 
 > `optional` **placehoders**: `string`[]
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:468](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/parse-command.ts#L468)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:7](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L7)
 
 ***
 
@@ -30,7 +30,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:468](htt
 
 > `optional` **placeholder**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:467](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/parse-command.ts#L467)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:6](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L6)
 
 ***
 
@@ -38,4 +38,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:467](htt
 
 > `optional` **startChar**: `string` \| `string`[]
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:465](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/parse-command.ts#L465)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/command-parser/utils.ts:4](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/command-parser/utils.ts#L4)

package/docs/api/interfaces/ResClientFuncParams.md

@@ -6,7 +6,7 @@
 
 # Interface: ResClientFuncParams
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/res-client-tools.ts#L5)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:51
 
 ## Extends
 
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:5](https://
 
 > `optional` **act**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-client-tool.ts#L5)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:9
 
 #### Inherited from
 
@@ -34,4 +34,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](h
 
 > `optional` **id**: `string` \| `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/res-client-tools.ts#L6)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:52

package/docs/api/interfaces/ResServerFuncParams.md

@@ -6,7 +6,7 @@
 
 # Interface: ResServerFuncParams
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/res-server-tools.ts#L5)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:65
 
 Defines the structure for parameters passed to a `ServerTools` function.
 By convention, it includes optional `_req` and `_res` properties for direct
@@ -26,7 +26,7 @@ access to the underlying transport's request and response objects (e.g., from No
 
 > `optional` **\_req**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/server-tools.ts#L15)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:295
 
 The underlying request object from the transport layer (e.g., `IncomingMessage`).
 
@@ -40,7 +40,7 @@ The underlying request object from the transport layer (e.g., `IncomingMessage`)
 
 > `optional` **\_res**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/server-tools.ts#L20)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:300
 
 The underlying response or reply object from the transport layer (e.g., `ServerResponse`).
 
@@ -50,11 +50,25 @@ The underlying response or reply object from the transport layer (e.g., `ServerR
 
 ***
 
+### \_signal?
+
+> `optional` **\_signal**: `AbortSignal`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:305
+
+The AbortSignal to monitor for cancellation or timeout.
+
+#### Inherited from
+
+[`RpcMethodsServerFuncParams`](RpcMethodsServerFuncParams.md).[`_signal`](RpcMethodsServerFuncParams.md#_signal)
+
+***
+
 ### act?
 
 > `optional` **act**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:7](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-server-tool.ts#L7)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:26
 
 #### Inherited from
 
@@ -66,7 +80,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:7](h
 
 > `optional` **id**: `string` \| `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/res-server-tools.ts#L6)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:66
 
 ***
 
@@ -74,4 +88,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:6](https://
 
 > `optional` **val**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/res-server-tools.ts#L8)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:67

package/docs/api/interfaces/RpcMethodsClientFuncParams.md

@@ -6,7 +6,7 @@
 
 # Interface: RpcMethodsClientFuncParams
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:4](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-client-tool.ts#L4)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:8
 
 ## Extended by
 
@@ -22,4 +22,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:4](h
 
 > `optional` **act**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-client-tool.ts#L5)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:9

package/docs/api/interfaces/RpcMethodsServerFuncParams.md

@@ -6,7 +6,7 @@
 
 # Interface: RpcMethodsServerFuncParams
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:6](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-server-tool.ts#L6)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:25
 
 Defines the structure for parameters passed to a `ServerTools` function.
 By convention, it includes optional `_req` and `_res` properties for direct
@@ -30,7 +30,7 @@ access to the underlying transport's request and response objects (e.g., from No
 
 > `optional` **\_req**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/server-tools.ts#L15)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:295
 
 The underlying request object from the transport layer (e.g., `IncomingMessage`).
 
@@ -44,7 +44,7 @@ The underlying request object from the transport layer (e.g., `IncomingMessage`)
 
 > `optional` **\_res**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/server-tools.ts#L20)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:300
 
 The underlying response or reply object from the transport layer (e.g., `ServerResponse`).
 
@@ -54,8 +54,22 @@ The underlying response or reply object from the transport layer (e.g., `ServerR
 
 ***
 
+### \_signal?
+
+> `optional` **\_signal**: `AbortSignal`
+
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index-359784IS.d.ts:305
+
+The AbortSignal to monitor for cancellation or timeout.
+
+#### Inherited from
+
+[`ServerFuncParams`](ServerFuncParams.md).[`_signal`](ServerFuncParams.md#_signal)
+
+***
+
 ### act?
 
 > `optional` **act**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:7](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/rpc-methods-server-tool.ts#L7)
+Defined in: @isdk/ai-tools/packages/tool-rpc/dist/index.d.ts:26

package/docs/api/interfaces/SanitizeFilenameOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: SanitizeFilenameOptions
 
-Defined in: @isdk/util/dist/index.d.ts:407
+Defined in: @isdk/util/dist/index.d.ts:408
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: @isdk/util/dist/index.d.ts:407
 
 > `optional` **maxLength**: `number`
 
-Defined in: @isdk/util/dist/index.d.ts:409
+Defined in: @isdk/util/dist/index.d.ts:410
 
 ***
 
@@ -22,4 +22,4 @@ Defined in: @isdk/util/dist/index.d.ts:409
 
 > `optional` **replacement**: `string`
 
-Defined in: @isdk/util/dist/index.d.ts:408
+Defined in: @isdk/util/dist/index.d.ts:409

package/docs/api/interfaces/SectionStringOptions.md

@@ -6,7 +6,7 @@
 
 # Interface: SectionStringOptions
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:193](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L193)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:193](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L193)
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:193](ht
 
 > `optional` **isMarkdown**: `boolean`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:194](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L194)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:194](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L194)
 
 ***
 
@@ -22,4 +22,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:194](ht
 
 > `optional` **nextLine**: `string`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:195](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/split-sentence.ts#L195)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/split-sentence.ts:195](https://github.com/isdk/ai-tool.js/blob/d10fb4cda65fc1975152a2c3ab327ecab008dea1/src/utils/split-sentence.ts#L195)

package/docs/api/interfaces/SemaphoreOptions.md

@@ -6,7 +6,9 @@
 
 # Interface: SemaphoreOptions
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:42](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L42)
+Defined in: @isdk/util/dist/index.d.ts:696
+
+通用信号量的配置选项，继承自二进制信号量选项。
 
 ## Extends
 
@@ -18,7 +20,10 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:42](ht
 
 > `optional` **capacity**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:25](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L25)
+Defined in: @isdk/util/dist/index.d.ts:654
+
+内部等待队列的初始预分配容量。
+适用于高性能场景，开发者可以根据并发规模预估此值以减少动态扩容。
 
 #### Inherited from
 
@@ -30,7 +35,11 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:25](ht
 
 > `optional` **initFn**: () => `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:22](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L22)
+Defined in: @isdk/util/dist/index.d.ts:637
+
+用于初始化令牌的函数。
+当信号量释放且没有等待任务时，如果未提供令牌，将调用此函数生成新令牌。
+默认为 `() => '1'`。
 
 #### Returns
 
@@ -46,7 +55,10 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:22](ht
 
 > `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:44](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L44)
+Defined in: @isdk/util/dist/index.d.ts:706
+
+可选的就绪检查函数。
+在尝试获取令牌前调用，如果返回 false（或解析为 false 的 Promise），则无法立即获取。
 
 ***
 
@@ -54,7 +66,10 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:44](ht
 
 > `optional` **maxConcurrency**: `number`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:43](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L43)
+Defined in: @isdk/util/dist/index.d.ts:701
+
+最大并发数。
+指定允许同时获取信号量的最大调用方数量。
 
 ***
 
@@ -62,7 +77,11 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:43](ht
 
 > `optional` **pauseFn**: () => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:23](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L23)
+Defined in: @isdk/util/dist/index.d.ts:643
+
+可选的暂停函数。
+当等待队列开始积压（第一个任务进入队列）时调用，用于通知上游停止发送数据，
+以避免产生过多的等待 Promise 导致内存溢出。
 
 #### Returns
 
@@ -78,7 +97,11 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:23](ht
 
 > `optional` **resumeFn**: () => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:24](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L24)
+Defined in: @isdk/util/dist/index.d.ts:649
+
+可选的恢复函数。
+当信号量有空闲槽位且之前已调用过 `pauseFn` 时调用。
+如果定义了 `pauseFn`，则必须同时定义此函数。
 
 #### Returns
 

package/docs/api/interfaces/SemaphoreTaskItem.md

@@ -6,7 +6,9 @@
 
 # Interface: SemaphoreTaskItem
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:52](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L52)
+Defined in: @isdk/util/dist/index.d.ts:711
+
+内部等待任务项的结构定义。
 
 ## Extends
 
@@ -16,13 +18,17 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:52](ht
 
 \[`n`: `string`\]: `any`
 
+允许扩展其他自定义选项。
+
 ## Properties
 
 ### reject()
 
 > **reject**: (`reason?`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:54](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L54)
+Defined in: @isdk/util/dist/index.d.ts:719
+
+当获取失败（如被中止）时调用的拒绝函数。
 
 #### Parameters
 
@@ -40,7 +46,9 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:54](ht
 
 > **resolve**: (`value`) => `void`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:53](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L53)
+Defined in: @isdk/util/dist/index.d.ts:715
+
+当获取成功时调用的解析函数，接收释放函数作为参数。
 
 #### Parameters
 
@@ -58,7 +66,10 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:53](ht
 
 > `optional` **signal**: `AbortSignal`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:29](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L29)
+Defined in: @isdk/util/dist/index.d.ts:664
+
+可选的 AbortSignal，用于取消获取操作。
+如果在获取到令牌前信号被中止，`acquire` 返回的 Promise 将被拒绝并抛出 `AbortError`。
 
 #### Inherited from
 
@@ -70,4 +81,6 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:29](ht
 
 > `optional` **token**: `any`
 
-Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:55](https://github.com/isdk/ai-tool.js/blob/e883e341c67e937e7d3a3e95e8bc56844896f5a3/src/utils/async-semaphore.ts#L55)
+Defined in: @isdk/util/dist/index.d.ts:723
+
+与此任务关联的令牌。