Aura.Model.HexRelease (Aura v0.9.0)
View SourceA struct describing a single release of a Aura.Model.HexPackage
Summary
Types
A mapping between a build-tool config (e.g "mix.exs"
), and the configuration needed to grab this release
(e.g "{:plug, "~> 0.8.3"}"
)
Whether this release has associated docs
URI reference to the Aura.Model.HexPackage
this release belongs to
SHA-256 checksum of the associated release tar.gz
Number of all time downloads of this release
Additional information relevant to the release
(e.g %{elixir: nil, app: "decimal", build_tools: ["mix"]}
)
Information about the user which published this release
(e.g %{url: (users url), username: "eric", email: "eric@example.com"}
)
A dependency of this release (e.g %{optional: false, app: "my_package", requirement: "~> 2.11.52"}
The version of this release
Whether this release is considered retired
Type describing an owner of a Aura.Model.HexRelease
Types
@type build_tool_declarations() :: map()
A mapping between a build-tool config (e.g "mix.exs"
), and the configuration needed to grab this release
(e.g "{:plug, "~> 0.8.3"}"
)
@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
@type release_checksum() :: String.t()
SHA-256 checksum of the associated release tar.gz
@type release_downloads() :: non_neg_integer()
Number of all time downloads of this release
@type release_meta() :: map()
Additional information relevant to the release
(e.g %{elixir: nil, app: "decimal", build_tools: ["mix"]}
)
@type release_publisher() :: map()
Information about the user which published this release
(e.g %{url: (users url), username: "eric", email: "eric@example.com"}
)
@type release_requirement() :: map()
A dependency of this release (e.g %{optional: false, app: "my_package", requirement: "~> 2.11.52"}
@type release_version() :: String.t()
The version of this release
@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: release_version() }
Type describing an owner of a Aura.Model.HexRelease
🏷️ Keys
- checksum ::
release_checksum/0
- configs ::
build_tool_declarations/0
- docs_html_url ::
Aura.Model.Common.docs_html_url/0
- has_docs ::
docs?/0
- meta ::
release_meta/0
- publisher ::
release_publisher/0
- html_url ::
Aura.Model.Common.html_url/0
- downloads ::
release_downloads/0