@spec demonitor_update(reference()) :: :ok | {:error, term()}

Stop monitoring document updates.

@spec get_array(t(), String.t()) :: Yex.Array.t()

Get or insert the array type.

@spec get_map(t(), String.t()) :: Yex.Map.t()

Get or insert the map type.

@spec get_text(t(), String.t()) :: Yex.Text.t()

Get or insert the text type.

Get or insert the xml fragment type.

@spec monitor_update(
  t(),
  keyword()
) :: {:ok, reference()} | {:error, term()}

Monitor document updates. You can pass metadata as an option. This value is passed as the fourth element of the message.If omitted, it will be passed as a structure of Doc itself.

@spec new(pid()) :: t()

Create a new document.

worker_pid: If there is a possibility of passing the created document to another process, please specify the process responsible for operating the document. This process needs to handle the GenServer handle_call messages as follows:

@impl true
def handle_call(
      {Yex.Doc, :run, fun},
      _from,
      state
    ) do
  {:reply, fun.(), state}
end

Executes the given block in the document's worker process. If the current process is already the worker process, executes directly. Otherwise, delegates execution to the worker process via GenServer.call.

Raises if worker_pid is not set.

@spec transaction(t(), origin :: term(), (... -> any())) :: term()

Start a transaction.

Raises RuntimeError if a transaction is already in progress.

Examples

iex> doc = Doc.new()
iex> text = Doc.get_text(doc, "text")
iex> Yex.Doc.monitor_update(doc)
iex> Doc.transaction(doc, fn ->
iex>   Text.insert(text, 0, "Hello")
iex>   Text.insert(text, 0, "Hello", %{"bold" => true})
iex> end)
iex> assert_receive {:update_v1, _, nil, _}
iex> refute_receive {:update_v1, _, nil, _} # only one update message

@spec with_options(Yex.Doc.Options.t(), pid()) :: t()

Create a new document with options.