DocRaptor.Status (DocRaptor v0.1.2)

Copy Markdown View Source

Status of an async job, or the JSON payload from a hosted sync create.

  • :status — :queued | :working | :completed | :failed (or nil for some hosted sync payloads)

  • :download_id / :download_url — set when ready (hosted URLs are public)
  • :number_of_pages, :message, :validation_errors — as returned by DocRaptor

Summary

Types

status()
t()

Types

status()

@type status() :: :queued | :working | :completed | :failed | atom() | nil

t()

@type t() :: %DocRaptor.Status{
  download_id: String.t() | nil,
  download_url: String.t() | nil,
  message: String.t() | nil,
  number_of_pages: non_neg_integer() | nil,
  status: status(),
  validation_errors: String.t() | nil
}