ClaudeAgentSDK.AbortSignal (claude_agent_sdk v0.6.9)

Lightweight cancellation token shared with callbacks.

Callbacks receive this via :signal in their context and can poll cancelled?/1 to cooperatively stop work when a cancel or shutdown occurs.

Summary

t()

Marks the signal as cancelled.

cancelled?(arg1)

Returns true if the signal has been cancelled.

new()

Creates a new abort signal.

@type t() :: %ClaudeAgentSDK.AbortSignal{ref: :atomics.atomics_ref()}

@spec cancel(t()) :: :ok

Marks the signal as cancelled.

@spec cancelled?(t() | nil) :: boolean()

Returns true if the signal has been cancelled.

@spec new() :: t()

Creates a new abort signal.