Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/core / / ToolExample
Interface: ToolExample<TInput, TOutput>
Defined in: packages/core/src/contracts/tool.ts:209
Worked example for a Tool. Type-parameterized on the same generics as Tool, so a ToolExample for Tool<{ q: string }, { hits: T[] }> cannot specify an input shape that does not match.
Stable
Type Parameters
| Type Parameter | Default type |
|---|---|
TInput | unknown |
TOutput | unknown |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
comment? | readonly | string | packages/core/src/contracts/tool.ts:212 |
input | readonly | TInput | packages/core/src/contracts/tool.ts:210 |
output | readonly | | TOutput | ToolReturn<TOutput> | packages/core/src/contracts/tool.ts:211 |