DOCSAPI reference

INTERFACE

ToolSet

Defined in: tool-set.ts:6

A collection of tools indexed by name.

Methods

addTool()

addTool(tool): void;

Defined in: tool-set.ts:12

Adds a tool. When the name is already registered, the first tool is kept.

Parameters

Parameter Type
tool Tool

Returns

void


getTool()

getTool(name): Tool | undefined;

Defined in: tool-set.ts:10

Returns the tool named name, or undefined.

Parameters

Parameter Type
name string

Returns

Tool | undefined


getTools()

getTools(): Tool[];

Defined in: tool-set.ts:8

Returns every tool in insertion order.

Returns

Tool[]


removeTool()

removeTool(name): boolean;

Defined in: tool-set.ts:14

Removes the tool named name. Returns true when a tool was removed.

Parameters

Parameter Type
name string

Returns

boolean


size()

size(): number;

Defined in: tool-set.ts:16

Returns the number of tools.

Returns

number