Aura.Model.HexPackage (Aura v1.0.1)
View SourceA struct describing a package from a Hex-compliant API
Examples
%Aura.Model.HexPackage{
name: "aura",
repository: "hexpm",
private: nil,
meta: %Aura.Model.HexPackageMeta{
maintainers: [],
links: %{
"Changelog" => "https://github.com/camatcode/aura/blob/master/CHANGELOG.md",
"GitHub" => "https://github.com/camatcode/aura",
"Website" => "https://github.com/camatcode/aura"
},
licenses: ["Apache-2.0"],
description: "An ergonomic library for investigating the Hex.pm API"
},
downloads: %Aura.Model.HexPackageDownloadStats{all: 4, week: 4, day: 4},
releases: [
%Aura.Model.HexRelease{
has_docs: true,
inserted_at: ~U[2025-06-01 15:13:00.595681Z],
version: "0.9.0",
url: "https://hex.pm/api/packages/aura/releases/0.9.0",
downloads: 0
}
],
inserted_at: ~U[2025-06-01 15:13:00.589838Z],
updated_at: ~U[2025-06-01 15:13:04.347899Z],
url: "https://hex.pm/api/packages/aura",
html_url: "https://hex.pm/packages/aura",
docs_html_url: "https://hexdocs.pm/aura/"
}
Resources
- Hex
- Contact the maintainer (he's happy to help!)
See Also
Summary
Types
@type private?() :: boolean()
Whether this package is publicly available
@type t() :: %Aura.Model.HexPackage{ docs_html_url: Aura.Model.Common.docs_html_url(), downloads: Aura.Model.HexPackageDownloadStats.t(), html_url: Aura.Model.Common.html_url(), inserted_at: Aura.Model.Common.inserted_at(), meta: Aura.Model.HexPackageMeta.t(), name: Aura.Common.package_name(), private: private?(), releases: [Aura.Model.HexRelease.t()], repository: Aura.Common.repo_name(), updated_at: Aura.Model.Common.updated_at(), url: Aura.Model.Common.url() }
Type describing a package from a Hex-compliant API
Keys
- meta ::
Aura.Model.HexPackageMeta.t/0
- name ::
Aura.Common.package_name/0
- private ::
Aura.Model.HexPackage.private?/0
- url ::
Aura.Model.Common.url/0
- repository ::
Aura.Common.repo_name/0
- releases :: [
Aura.Model.HexRelease.t/0
] - inserted_at ::
Aura.Model.Common.inserted_at/0
- updated_at ::
Aura.Model.Common.updated_at/0
- downloads ::
Aura.Model.HexPackageDownloadStats.t/0
- html_url ::
Aura.Model.Common.html_url/0
- docs_html_url ::
Aura.Model.Common.docs_html_url/0
Examples
%Aura.Model.HexPackage{
name: "aura",
repository: "hexpm",
private: nil,
meta: %Aura.Model.HexPackageMeta{
maintainers: [],
links: %{
"Changelog" => "https://github.com/camatcode/aura/blob/master/CHANGELOG.md",
"GitHub" => "https://github.com/camatcode/aura",
"Website" => "https://github.com/camatcode/aura"
},
licenses: ["Apache-2.0"],
description: "An ergonomic library for investigating the Hex.pm API"
},
downloads: %Aura.Model.HexPackageDownloadStats{all: 4, week: 4, day: 4},
releases: [
%Aura.Model.HexRelease{
has_docs: true,
inserted_at: ~U[2025-06-01 15:13:00.595681Z],
version: "0.9.0",
url: "https://hex.pm/api/packages/aura/releases/0.9.0",
downloads: 0
}
],
inserted_at: ~U[2025-06-01 15:13:00.589838Z],
updated_at: ~U[2025-06-01 15:13:04.347899Z],
url: "https://hex.pm/api/packages/aura",
html_url: "https://hex.pm/packages/aura",
docs_html_url: "https://hexdocs.pm/aura/"
}
See Also
Functions
Builds a HexPackage
from a map
Parameters
Parameter | Description |
---|---|
m | A map to build into a Aura.Model.HexPackage.t/0 |