NLdoc.Conversion.Reader.Tiptap (NLdoc.Conversion.Reader.Tiptap v2.1.1)

View Source

Reader for convert_elementing Tiptap elements to Spec Resources.

Summary

Types

error()
input(resource)
opt()
output(value)
tiptap_element()

Functions

convert(doc, opts \\ [])

Types

error()

@type error() :: {:error, term()}

input(resource)

@type input(resource) ::
  {resource, state :: NLdoc.Conversion.Reader.Tiptap.State.t(),
   ctx :: NLdoc.Conversion.Reader.Tiptap.Context.t()}

opt()

@type opt() :: {:strict, boolean()}

output(value)

@type output(value) ::
  {:ok, {value, state :: NLdoc.Conversion.Reader.Tiptap.State.t()}} | error()

tiptap_element()

@type tiptap_element() :: %{type: String.t()}

Functions

convert(doc, opts \\ [])

@spec convert(doc :: tiptap_element(), [{:opts, [opt()]}]) ::
  {:ok, NLdoc.Spec.Document.t()} | error()