@type build_tool_declarations() :: map()

A mapping between a build-tool config and the configuration needed to grab this release

Examples

   %{
     "erlang.mk" => "dep_aura = hex 0.9.0",
     "mix.exs" => "{:aura, "~> 0.9.0"}",
     "rebar.config" => "{aura, "0.9.0"}"
   }

See Also

• Aura.Releases

@type docs?() :: boolean()

Whether this release has associated docs

@type package_reference_url() :: URI.t()

URI reference to the Aura.Model.HexPackage this release belongs to

Examples

"https://hex.pm/api/packages/aura/releases/0.9.0"

See Also

• Aura.Releases

@type release_checksum() :: String.t()

SHA-256 checksum of the associated release tar.gz

Examples

  "4eaafe67a4b2d3a3b7f4637106ce81707cfa0977e6b3b44450cde4c4626a3c1a"

See Also

• Aura.Releases

@type release_downloads() :: non_neg_integer()

Number of all time downloads of this release

@type release_meta() :: map()

Additional information relevant to the release

Examples

%{elixir: "~> 1.18", app: "aura", build_tools: ["mix"]}

See Also

• Aura.Releases

@type release_publisher() :: map()

Information about the user which published this release

Examples

%{
 url: "https://hex.pm/api/users/camatcode",
 username: "camatcode",
 email: "cam.cook.codes@gmail.com"
}

See Also

• Aura.Releases

@type release_requirement() :: map()

A dependency of this release

Examples

%{optional: false, app: "req", requirement: "~> 0.5.10"}

See Also

• Aura.Releases

@type retired?() :: boolean()

Whether this release is considered retired

@type t() :: %Aura.Model.HexRelease{
  checksum: release_checksum(),
  configs: build_tool_declarations(),
  docs_html_url: Aura.Model.Common.docs_html_url(),
  downloads: release_downloads(),
  has_docs: docs?(),
  html_url: Aura.Model.Common.html_url(),
  inserted_at: Aura.Model.Common.inserted_at(),
  meta: release_meta(),
  package_url: package_reference_url(),
  publisher: release_publisher(),
  requirements: [release_requirement()],
  retirement: retired?(),
  updated_at: Aura.Model.Common.updated_at(),
  url: Aura.Model.Common.url(),
  version: Aura.Common.release_version()
}

Type describing a Aura.Model.HexRelease

Keys

• meta :: Aura.Model.HexRelease.release_meta/0
• version :: Aura.Common.release_version/0
• checksum :: Aura.Model.HexRelease.release_checksum/0
• url :: Aura.Model.Common.url/0
• requirements :: [Aura.Model.HexRelease.release_requirement/0]
• inserted_at :: Aura.Model.Common.inserted_at/0
• updated_at :: Aura.Model.Common.updated_at/0
• downloads :: Aura.Model.HexRelease.release_downloads/0
• html_url :: Aura.Model.Common.html_url/0
• docs_html_url :: Aura.Model.Common.docs_html_url/0
• configs :: Aura.Model.HexRelease.build_tool_declarations/0
• has_docs :: Aura.Model.HexRelease.docs?/0
• publisher :: Aura.Model.HexRelease.release_publisher/0
• retirement :: Aura.Model.HexRelease.retired?/0
• package_url :: Aura.Model.HexRelease.package_reference_url/0

Examples

%Aura.Model.HexRelease{
 checksum: "4eaafe67a4b2d3a3b7f4637106ce81707cfa0977e6b3b44450cde4c4626a3c1a",
 configs: %{
   "erlang.mk" => "dep_aura = hex 0.9.0",
   "mix.exs" => "{:aura, "~> 0.9.0"}",
   "rebar.config" => "{aura, "0.9.0"}"
 },
 docs_html_url: "https://hexdocs.pm/aura/0.9.0/",
 has_docs: true,
 html_url: "https://hex.pm/packages/aura/0.9.0",
 inserted_at: ~U[2025-06-01 15:13:00.595681Z],
 meta: %{elixir: "~> 1.18", app: "aura", build_tools: ["mix"]},
 package_url: "https://hex.pm/api/packages/aura",
 publisher: %{
   url: "https://hex.pm/api/users/camatcode",
   username: "camatcode",
   email: "cam.cook.codes@gmail.com"
 },
 requirements: [
   %{optional: false, app: "cachex", requirement: "~> 4.0"},
   %{optional: false, app: "date_time_parser", requirement: "~> 1.2.0"},
   %{optional: false, app: "proper_case", requirement: "~> 1.3"},
   %{optional: false, app: "req", requirement: "~> 0.5.10"}
 ],
 retirement: nil,
 updated_at: ~U[2025-06-01 15:13:04.347130Z],
 version: "0.9.0",
 url: "https://hex.pm/api/packages/aura/releases/0.9.0",
 downloads: 15
 }

See Also

• Aura.Releases