Codex.Protocol.RequestUserInput.Question (Codex SDK v0.16.1)

A question to present to the user

Summary

Types

t()

Functions

from_map(data)

parse(question)

parse!(question)

schema()

to_map(question)

Types

t()

@type t() :: %Codex.Protocol.RequestUserInput.Question{
  extra: map(),
  header: String.t(),
  id: String.t(),
  is_other: boolean(),
  is_secret: boolean(),
  options: ([Codex.Protocol.RequestUserInput.Option.t()] | nil) | nil,
  question: String.t()
}

Functions

from_map(data)

@spec from_map(map()) :: t()

parse(question)

@spec parse(map() | keyword() | t()) ::
  {:ok, t()}
  | {:error,
     {:invalid_request_user_input_question,
      CliSubprocessCore.Schema.error_detail()}}

parse!(question)

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

schema()

@spec schema() :: Zoi.schema()

to_map(question)

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