This is the documentation of version 0.58.1. Go to the latest version, 1.0.0-rc.5.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ToolExecuteOptions

    Per-call options handed to a tool's execute, separate from its parsed input.

    signal is the AI SDK's own abortSignal for the tool call — it fires when the model's turn is cancelled. Forward it to any @tomtom-org/maps-sdk/services call the tool makes (as signal) so a cancelled turn also cancels its in-flight HTTP requests.

    Do NOT forward it into work that outlives the turn — a monitor's recurring tick, or any deferred job. Those fire after the signal has aborted, and a monitor treats a rejected tick as fatal (it clears its own interval), so a leaked signal kills the monitor rather than cancelling a request.

    type ToolExecuteOptions = {
        signal?: AbortSignal;
    }
    Index
    signal?: AbortSignal