CanvasNative v1.1.0 CanvasNative.V0.OrderedListType

An item in an ordered list in a v0 canvas native document.

iex> source = wrap(type_name <> "-1") <> "2. OLLI"
iex> OrderedListType.match_native(source)
%OrderedListType{content: "OLLI",
                source: wrap("ordered-list-item-1") <> "2. OLLI",
                type: type_name, level: 1, number: 2}

Summary

Functions

Format a line as a JSON object

Match a native string against @native_pattern, returning a struct or nil

Name for this type

Types

t :: %CanvasNative.V0.OrderedListType{content: String.t, level: pos_integer, number: integer, source: String.t, type: String.t}

Functions

as_json(struct)

Specs

as_json(t) :: map

Format a line as a JSON object.

match_markdown(markdown, ctx \\ %{has_title: false, in_code: false, last_line_blank: false})

Specs

Match a Markdown string and return a struct or nil.

match_native(native)

Specs

match_native(String.t) :: t | nil

Match a native string against @native_pattern, returning a struct or nil.

new(map)

Specs

new(map) :: t
type_name()

Specs

type_name :: String.t

Name for this type.