Interface SketchedToolParameterDefinition

interface SketchedToolParameterDefinition {
    description: string;
    itemProperties?: SketchedToolParameterDefinition[];
    itemType?: "string" | "number" | "boolean" | "object" | "integer";
    name: string;
    properties?: SketchedToolParameterDefinition[];
    required?: boolean;
    type: SketchedToolParameterType;
}

Index

Properties

description itemProperties? itemType? name properties? required? type

Properties

description

description: string

`Optional`itemProperties

itemProperties?: SketchedToolParameterDefinition[]

For type 'array' with itemType 'object': properties of the item object

`Optional`itemType

itemType?: "string" | "number" | "boolean" | "object" | "integer"

For type 'array': item type

name

name: string

`Optional`properties

properties?: SketchedToolParameterDefinition[]

For type 'object': nested properties (max 2 levels)

`Optional`required

required?: boolean

type

type: SketchedToolParameterType