Codex.Events (Codex SDK v0.3.0)

View Source

Typed event structs emitted during Codex turn execution.

Provides helpers to parse JSON-decoded maps into strongly typed structs and to convert structs back into protocol maps for encoding.

Summary

Types

t()

Functions

parse!(map)

Parses a JSON-decoded map into a typed event struct, raising on unknown event types.

to_map(event)

Converts a typed event struct back into the JSON-serializable map representation.

Types

t()

@type t() ::
  Codex.Events.ThreadStarted.t()
  | Codex.Events.TurnStarted.t()
  | Codex.Events.TurnContinuation.t()
  | Codex.Events.TurnCompleted.t()
  | Codex.Events.ThreadTokenUsageUpdated.t()
  | Codex.Events.TurnDiffUpdated.t()
  | Codex.Events.TurnPlanUpdated.t()
  | Codex.Events.TurnCompaction.t()
  | Codex.Events.ItemAgentMessageDelta.t()
  | Codex.Events.ItemInputTextDelta.t()
  | Codex.Events.ItemCompleted.t()
  | Codex.Events.ItemStarted.t()
  | Codex.Events.ItemUpdated.t()
  | Codex.Events.CommandOutputDelta.t()
  | Codex.Events.ReasoningDelta.t()
  | Codex.Events.ReasoningSummaryDelta.t()
  | Codex.Events.AppServerNotification.t()
  | Codex.Events.Error.t()
  | Codex.Events.TurnFailed.t()
  | Codex.Events.ToolCallRequested.t()
  | Codex.Events.ToolCallCompleted.t()

Functions

parse!(map)

@spec parse!(map()) :: t()

Parses a JSON-decoded map into a typed event struct, raising on unknown event types.

to_map(event)

@spec to_map(t()) :: map()

Converts a typed event struct back into the JSON-serializable map representation.