Skip to main content

Types

Complete type definitions for the JavaScript/TypeScript SDK.

Client Types

ClientOptions

ConnectionStatus

ClientEventHandlers

Session Types

SessionOptions

SessionState

SessionEventHandlers

SessionInfo

Options Types

BaseOptions

Shared options for sessions and prompts.

PromptOptions

SystemPromptConfig

OutputFormat

PermissionMode

Result Types

SessionResult

PromptResult

Usage

Message Types

Message

ContentBlock

Streaming Types

StreamingEvent

Tool Types

ToolDefinition

ToolInputSchema

ToolHandler

ToolResult

ToolCall

MCP Types

McpServer

Token Types

CreateTokenOptions

TokenBudget

TokenPermissions

TokenSdkConfig

DecodedToken

Error Types

ChuckyError

Error Codes