Current section

Files

Jump to
html_to_markdown lib html_to_markdown visit_result.ex
Raw

lib/html_to_markdown/visit_result.ex

# This file is auto-generated by alef — DO NOT EDIT.
# alef:hash:094484387808183514a801bab05d27e52c1d7d3d595e8913feed7cad1498eee3
# To regenerate: alef generate
# To verify freshness: alef verify --exit-code
# Issues & docs: https://github.com/kreuzberg-dev/alef
defmodule HtmlToMarkdown.VisitResult do
@moduledoc """
Result of a visitor callback.
Allows visitors to control the conversion flow by either proceeding
with default behavior, providing custom output, skipping elements,
preserving HTML, or signaling errors.
"""
@typedoc "Result of a visitor callback."
@type t :: term()
@typedoc "Continue with default conversion behavior"
@type continue :: :continue
@typedoc "Replace default output with custom markdown"
@type custom :: %{type: :custom, value: String.t()}
@typedoc "Skip this element entirely (don't output anything)"
@type skip :: :skip
@typedoc "Preserve original HTML (don't convert to markdown)"
@type preserve_html :: :preserve_html
@typedoc "Stop conversion with an error"
@type error :: %{type: :error, value: String.t()}
end