@isdk/ai-tool 0.5.2 → 0.5.3

package/docs/interfaces/RemoteFuncItem.md

@@ -0,0 +1,152 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / RemoteFuncItem
+
+# Interface: RemoteFuncItem
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:33](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L33)
+
+## Extends
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+## Extended by
+
+- [`ClientFuncItem`](ClientFuncItem.md)
+- [`ServerFuncItem`](ServerFuncItem.md)
+
+## Properties
+
+### action?
+
+> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L35)
+
+***
+
+### apiRoot?
+
+> `optional` **apiRoot**: `string`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L34)
+
+***
+
+### fetchOptions?
+
+> `optional` **fetchOptions**: `any`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L36)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L25)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)

package/docs/interfaces/ReplacePlacehoderOptions.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ReplacePlacehoderOptions
+
+# Interface: ReplacePlacehoderOptions
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:464](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L464)
+
+## Properties
+
+### endChar?
+
+> `optional` **endChar**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:466](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L466)
+
+***
+
+### placehoders?
+
+> `optional` **placehoders**: `string`[]
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:468](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L468)
+
+***
+
+### placeholder?
+
+> `optional` **placeholder**: `string`
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:467](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L467)
+
+***
+
+### startChar?
+
+> `optional` **startChar**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:465](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L465)

package/docs/interfaces/ResClientFuncParams.md

@@ -0,0 +1,37 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ResClientFuncParams
+
+# Interface: ResClientFuncParams
+
+Defined in: [packages/ai-tool/src/res-client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/res-client-tools.ts#L5)
+
+## Extends
+
+- `RpcMethodsClientFuncParams`
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### act?
+
+> `optional` **act**: `string`
+
+Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/rpc-methods-client-tool.ts#L5)
+
+#### Inherited from
+
+`RpcMethodsClientFuncParams.act`
+
+***
+
+### id?
+
+> `optional` **id**: `string` \| `number`
+
+Defined in: [packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/res-client-tools.ts#L6)

package/docs/interfaces/ResServerFuncParams.md

@@ -0,0 +1,69 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ResServerFuncParams
+
+# Interface: ResServerFuncParams
+
+Defined in: [packages/ai-tool/src/res-server-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/res-server-tools.ts#L5)
+
+## Extends
+
+- `RpcMethodsServerFuncParams`
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### \_req?
+
+> `optional` **\_req**: `IncomingMessage`
+
+Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L9)
+
+#### Inherited from
+
+`RpcMethodsServerFuncParams._req`
+
+***
+
+### \_res?
+
+> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
+
+Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L10)
+
+#### Inherited from
+
+`RpcMethodsServerFuncParams._res`
+
+***
+
+### act?
+
+> `optional` **act**: `string`
+
+Defined in: [packages/ai-tool/src/rpc-methods-server-tool.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/rpc-methods-server-tool.ts#L7)
+
+#### Inherited from
+
+`RpcMethodsServerFuncParams.act`
+
+***
+
+### id?
+
+> `optional` **id**: `string` \| `number`
+
+Defined in: [packages/ai-tool/src/res-server-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/res-server-tools.ts#L6)
+
+***
+
+### val?
+
+> `optional` **val**: `any`
+
+Defined in: [packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/res-server-tools.ts#L8)

package/docs/interfaces/SanitizeFilenameOptions.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SanitizeFilenameOptions
+
+# Interface: SanitizeFilenameOptions
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:83](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/filename.ts#L83)
+
+## Properties
+
+### maxLength?
+
+> `optional` **maxLength**: `number`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/filename.ts#L85)
+
+***
+
+### replacement?
+
+> `optional` **replacement**: `string`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/filename.ts#L84)

package/docs/interfaces/SectionStringOptions.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SectionStringOptions
+
+# Interface: SectionStringOptions
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:193](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L193)
+
+## Properties
+
+### isMarkdown?
+
+> `optional` **isMarkdown**: `boolean`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:194](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L194)
+
+***
+
+### nextLine?
+
+> `optional` **nextLine**: `string`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:195](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L195)

package/docs/interfaces/SemaphoreOptions.md

@@ -0,0 +1,89 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SemaphoreOptions
+
+# Interface: SemaphoreOptions
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:42](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L42)
+
+## Extends
+
+- [`BinarySemaphoreOptions`](BinarySemaphoreOptions.md)
+
+## Properties
+
+### capacity?
+
+> `optional` **capacity**: `number`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L25)
+
+#### Inherited from
+
+[`BinarySemaphoreOptions`](BinarySemaphoreOptions.md).[`capacity`](BinarySemaphoreOptions.md#capacity)
+
+***
+
+### initFn()?
+
+> `optional` **initFn**: () => `any`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:22](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L22)
+
+#### Returns
+
+`any`
+
+#### Inherited from
+
+[`BinarySemaphoreOptions`](BinarySemaphoreOptions.md).[`initFn`](BinarySemaphoreOptions.md#initfn)
+
+***
+
+### isReadyFn?
+
+> `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:44](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L44)
+
+***
+
+### maxConcurrency?
+
+> `optional` **maxConcurrency**: `number`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:43](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L43)
+
+***
+
+### pauseFn()?
+
+> `optional` **pauseFn**: () => `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L23)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BinarySemaphoreOptions`](BinarySemaphoreOptions.md).[`pauseFn`](BinarySemaphoreOptions.md#pausefn)
+
+***
+
+### resumeFn()?
+
+> `optional` **resumeFn**: () => `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L24)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BinarySemaphoreOptions`](BinarySemaphoreOptions.md).[`resumeFn`](BinarySemaphoreOptions.md#resumefn)

package/docs/interfaces/SemaphoreTaskItem.md

@@ -0,0 +1,73 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SemaphoreTaskItem
+
+# Interface: SemaphoreTaskItem
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:52](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L52)
+
+## Extends
+
+- [`BinarySemaphoreAcquireOptions`](BinarySemaphoreAcquireOptions.md)
+
+## Indexable
+
+\[`n`: `string`\]: `any`
+
+## Properties
+
+### reject()
+
+> **reject**: (`reason`?) => `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:54](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L54)
+
+#### Parameters
+
+##### reason?
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### resolve()
+
+> **resolve**: (`value`) => `void`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:53](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L53)
+
+#### Parameters
+
+##### value
+
+`any`
+
+#### Returns
+
+`void`
+
+***
+
+### signal?
+
+> `optional` **signal**: `AbortSignal`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L29)
+
+#### Inherited from
+
+[`BinarySemaphoreAcquireOptions`](BinarySemaphoreAcquireOptions.md).[`signal`](BinarySemaphoreAcquireOptions.md#signal)
+
+***
+
+### token?
+
+> `optional` **token**: `any`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:55](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L55)

package/docs/interfaces/ServerFuncItem.md

@@ -0,0 +1,171 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ServerFuncItem
+
+# Interface: ServerFuncItem
+
+Defined in: [packages/ai-tool/src/server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L13)
+
+## Extends
+
+- [`RemoteFuncItem`](RemoteFuncItem.md)
+
+## Extended by
+
+- [`ServerTools`](../classes/ServerTools.md)
+
+## Properties
+
+### action?
+
+> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L35)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
+
+***
+
+### allowExportFunc?
+
+> `optional` **allowExportFunc**: `boolean`
+
+Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L14)
+
+***
+
+### apiRoot?
+
+> `optional` **apiRoot**: `string`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L34)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
+
+***
+
+### fetchOptions?
+
+> `optional` **fetchOptions**: `any`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L36)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L25)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)