EffectTool
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
|
|
|
|
|
|
Properties
Section titled “Properties”description
Section titled “description”description: string;execute
Section titled “execute”execute: (args, ctx?) => Promise<TOutput> | AsyncIterable<TOutput, any, any>;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
|
|
Returns
Section titled “Returns”Promise<TOutput> | AsyncIterable<TOutput, any, any>
input?
Section titled “input?”optional input?: StandardSchemaV1<TInput, TInput>;interim?
Section titled “interim?”optional interim?: string;interimAfterMs?
Section titled “interimAfterMs?”optional interimAfterMs?: number;interruptible?
Section titled “interruptible?”optional interruptible?: boolean;name: string;needsApproval?
Section titled “needsApproval?”optional needsApproval?: boolean;output?
Section titled “output?”optional output?: StandardSchemaV1<TOutput, TOutput>;replay?
Section titled “replay?”optional replay?: boolean;When false, the durable journal always re-executes this tool instead of returning a cached step result — for observation/mutation tools (fs, shell) whose result must be fresh. Default true.
timeoutMs?
Section titled “timeoutMs?”optional timeoutMs?: number;