tools / Exports / BaseToolOptions
Interface: BaseToolOptions<TParams, TResult>
Base tool options interface
Type parameters
| Name | Type | Description |
|---|---|---|
TParams | any | Parameter type |
TResult | any | Result type |
Hierarchy
BaseToolOptions
Table of contents
Properties
Properties
name
• name: string
Defined in
packages/tools/src/tool/interfaces.ts:63
description
• description: string
Defined in
packages/tools/src/tool/interfaces.ts:64
category
• Optional category: string
Defined in
packages/tools/src/tool/interfaces.ts:65
version
• Optional version: string
Defined in
packages/tools/src/tool/interfaces.ts:66
validateParams
• Optional validateParams: boolean
Defined in
packages/tools/src/tool/interfaces.ts:67
execute
• execute: (params: TParams) => ToolResult<TResult> | Promise<ToolResult<TResult>>
Type declaration
▸ (params): ToolResult<TResult> | Promise<ToolResult<TResult>>
Parameters
| Name | Type |
|---|---|
params | TParams |
Returns
ToolResult<TResult> | Promise<ToolResult<TResult>>
Defined in
packages/tools/src/tool/interfaces.ts:68
beforeExecute
• Optional beforeExecute: (params: TParams) => TParams | Promise<TParams>
Type declaration
▸ (params): TParams | Promise<TParams>
Parameters
| Name | Type |
|---|---|
params | TParams |
Returns
TParams | Promise<TParams>
Defined in
packages/tools/src/tool/interfaces.ts:69
afterExecute
• Optional afterExecute: (result: ToolResult<TResult>) => ToolResult<TResult> | Promise<ToolResult<TResult>>
Type declaration
▸ (result): ToolResult<TResult> | Promise<ToolResult<TResult>>
Parameters
| Name | Type |
|---|---|
result | ToolResult<TResult> |
Returns
ToolResult<TResult> | Promise<ToolResult<TResult>>