View Source Jsonpatch.Operation.Remove (Jsonpatch v2.2.1)

A JSON patch remove operation is responsible for removing values.

Examples 

iex> remove = %Jsonpatch.Operation.Remove{path: "/a/b"}
iex> target = %{"a" => %{"b" => %{"c" => "Bob"}}, "d" => false}
iex> Jsonpatch.Operation.Remove.apply(remove, target, [])
{:ok, %{"a" => %{}, "d" => false}}

iex> remove = %Jsonpatch.Operation.Remove{path: "/a/b"}
iex> target = %{"a" => %{"b" => nil}, "d" => false}
iex> Jsonpatch.Operation.Remove.apply(remove, target, [])
{:ok, %{"a" => %{}, "d" => false}}

Summary

Types

t()

Functions

apply(remove, target, opts)

Types

Link to this type

t()

View Source 
@type t() :: %Jsonpatch.Operation.Remove{path: String.t()}

Functions

Link to this function

apply(remove, target, opts)

View Source 
@spec apply(
  Jsonpatch.t(),
  target :: Jsonpatch.Types.json_container(),
  Jsonpatch.Types.opts()
) ::
  {:ok, Jsonpatch.Types.json_container()} | Jsonpatch.Types.error()