Codex.Protocol.Plugin.ReadParams (Codex SDK v0.16.1)

Typed params for plugin/read.

Summary

t()

from_map(data)

parse(params)

parse!(params)

schema()

to_map(params)

@type t() :: %Codex.Protocol.Plugin.ReadParams{
  extra: map(),
  marketplace_path: String.t(),
  plugin_name: String.t()
}

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

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

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

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

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