ClaudeCode.Message (ClaudeCode v0.29.0)

View Source

Utilities for working with messages from the Claude CLI.

Messages can be system initialization, assistant responses, user tool results, result messages, stream events, conversation compaction boundaries, or informational messages (rate limits, tool progress, auth status, etc.). This module provides functions to parse and work with any message type.

Summary

Types

t()

Functions

message?(arg1)

Checks if a value is any type of message.

message_type(arg1)

Returns the type of a message.

Types

t()

@type t() ::
  ClaudeCode.Message.SystemMessage.t()
  | ClaudeCode.Message.CompactBoundaryMessage.t()
  | ClaudeCode.Message.AssistantMessage.t()
  | ClaudeCode.Message.UserMessage.t()
  | ClaudeCode.Message.ResultMessage.t()
  | ClaudeCode.Message.PartialAssistantMessage.t()
  | ClaudeCode.Message.RateLimitEvent.t()
  | ClaudeCode.Message.ToolProgressMessage.t()
  | ClaudeCode.Message.ToolUseSummaryMessage.t()
  | ClaudeCode.Message.AuthStatusMessage.t()
  | ClaudeCode.Message.PromptSuggestionMessage.t()

Functions

message?(arg1)

@spec message?(any()) :: boolean()

Checks if a value is any type of message.

message_type(arg1)

@spec message_type(t()) ::
  :system
  | :assistant
  | :user
  | :result
  | :stream_event
  | :rate_limit_event
  | :tool_progress
  | :tool_use_summary
  | :auth_status
  | :prompt_suggestion

Returns the type of a message.