Mq.Options (mq_elixir v0.1.17)

View Source

Configuration options for mq query execution.

Fields

  • :input_format - Input format (:markdown, :mdx, :text, :html, :raw, :null)
  • :list_style - List marker style (:dash, :plus, :star)
  • :link_title_style - Link title quoting (:double, :single, :paren)
  • :link_url_style - Link URL wrapping (:angle, :none)

Summary

Functions

Convert Options struct to a map for passing to NIF. Filters out nil values.

Types

input_format()

@type input_format() :: :markdown | :mdx | :text | :html | :raw | :null

list_style()

@type list_style() :: :dash | :plus | :star

t()

@type t() :: %Mq.Options{
  input_format: input_format() | nil,
  link_title_style: title_surround_style() | nil,
  link_url_style: url_surround_style() | nil,
  list_style: list_style() | nil
}

title_surround_style()

@type title_surround_style() :: :double | :single | :paren

url_surround_style()

@type url_surround_style() :: :angle | :none

Functions

to_map(opts)

@spec to_map(t()) :: map()

Convert Options struct to a map for passing to NIF. Filters out nil values.