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

Copy Markdown View Source

An option for a question

Summary

Types

t()

Functions

from_map(data)
parse(option)
parse!(option)
schema()
to_map(option)

Types

t()

@type t() :: %Codex.Protocol.RequestUserInput.Option{
  description: String.t(),
  extra: map(),
  label: String.t()
}

Functions

from_map(data)

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

parse(option)

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

parse!(option)

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

schema()

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

to_map(option)

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