Wardrik.Operations.Types (wardrik_protocol v0.1.0-rc.1)

Converts each operation's input and output between Elixir and the protocol's JSON.

Input is keyword lists and structs. Output is structs, lists and :ok.

Summary

Converts the operation's JSON output to what an Elixir caller gets.

Converts an Elixir caller's input to the operation's JSON input.

event(arg)

Converts a streamed event and its cursor to {%Wardrik.Event{}, cursor}.

path(text)

Returns the path segment for value: a string as given, or a struct's ID or name.

@spec decode(String.t(), map() | nil) :: term()

Converts the operation's JSON output to what an Elixir caller gets.

@spec encode(String.t(), term()) :: map()

Converts an Elixir caller's input to the operation's JSON input.

@spec event({map(), String.t()}) :: {Wardrik.Event.t(), String.t()}

Converts a streamed event and its cursor to {%Wardrik.Event{}, cursor}.

@spec path(String.t() | struct()) :: String.t()

Returns the path segment for value: a string as given, or a struct's ID or name.