Aura.Model.HexRelease (Aura v0.9.0)

View Source

A 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

t()

Type describing an owner of a Aura.Model.HexRelease

Functions

Builds a HexRelease from a map

Types

build_tool_declarations()

@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"}")

docs?()

@type docs?() :: boolean()

Whether this release has associated docs

package_reference_url()

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

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

release_checksum()

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

SHA-256 checksum of the associated release tar.gz

release_downloads()

@type release_downloads() :: non_neg_integer()

Number of all time downloads of this release

release_meta()

@type release_meta() :: map()

Additional information relevant to the release (e.g %{elixir: nil, app: "decimal", build_tools: ["mix"]})

release_publisher()

@type release_publisher() :: map()

Information about the user which published this release (e.g %{url: (users url), username: "eric", email: "eric@example.com"})

release_requirement()

@type release_requirement() :: map()

A dependency of this release (e.g %{optional: false, app: "my_package", requirement: "~> 2.11.52"}

release_version()

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

The version of this release

retired?()

@type retired?() :: boolean()

Whether this release is considered retired

t()

@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

Functions

build(m)

@spec build(m :: map()) :: t()

Builds a HexRelease from a map