Skip to content

@vtj


@vtj / designer / ToolParameter

Interface: ToolParameter ​

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:8

工具参数定义

Properties ​

description? ​

optional description: string

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:20

参数描述


enum? ​

optional enum: string[]

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:30

枚举值(仅适用于string类型)


items? ​

optional items: Omit<ToolParameter, "name">

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:38

数组元素类型定义(仅在type为'array'时使用)


name ​

name: string

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:12

参数名称


properties? ​

optional properties: Record<string, Omit<ToolParameter, "name">>

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:34

对象属性定义(仅在type为'object'时使用)


required? ​

optional required: boolean

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:24

是否必需


rest? ​

optional rest: boolean

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:26

是否接收剩余位置参数;仅允许用于最后一个参数定义


type ​

type: ToolParameterType

Defined in: packages/designer/types/framework/ToolRegistry.d.ts:16

参数类型