DOCSAPI reference

CLASS

DefaultToolSet

Defined in: tool-set.ts:22

Map-backed ToolSet implementation.

Implements

Constructors

Constructor

new DefaultToolSet(tools?): DefaultToolSet;

Defined in: tool-set.ts:28

Parameters

Parameter Type Default value Description
tools? Tool[] [] Initial tools. Later duplicates of a name are ignored.

Returns

DefaultToolSet

Methods

addTool()

addTool(tool): void;

Defined in: tool-set.ts:42

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

Parameters

Parameter Type
tool Tool

Returns

void

Implementation of

ToolSet.addTool


getTool()

getTool(name): Tool | undefined;

Defined in: tool-set.ts:38

Returns the tool named name, or undefined.

Parameters

Parameter Type
name string

Returns

Tool | undefined

Implementation of

ToolSet.getTool


getTools()

getTools(): Tool[];

Defined in: tool-set.ts:34

Returns every tool in insertion order.

Returns

Tool[]

Implementation of

ToolSet.getTools


removeTool()

removeTool(name): boolean;

Defined in: tool-set.ts:49

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

Parameters

Parameter Type
name string

Returns

boolean

Implementation of

ToolSet.removeTool


size()

size(): number;

Defined in: tool-set.ts:53

Returns the number of tools.

Returns

number

Implementation of

ToolSet.size