Aura.Model.HexPackageMeta (Aura v0.9.1)
View SourceA struct describing additional metadata about a Aura.Model.HexPackage
💻 Examples
%Aura.Model.HexPackageMeta{
maintainers: [],
links: %{"GitHub" => "https://github.com/michalmuskala/jason"},
licenses: ["Apache-2.0"],
description: "A blazing fast JSON parser and generator in pure Elixir."
}
👀 See Also
📖 Resources
- 💬 Contact the maintainer (he's happy to help!)
Summary
Types
Additional external URL relating to the package
Short, human-readable description of the package
The software license associated to the package
Type describing additional metadata about a Aura.Model.HexPackage
Types
@type meta_url() :: URI.t()
Additional external URL relating to the package
💻 Examples
"https://github.com/michalmuskala/jason"
👀 See Also
@type package_description() :: String.t()
Short, human-readable description of the package
💻 Examples
"A blazing fast JSON parser and generator in pure Elixir."
👀 See Also
@type software_license() :: String.t()
The software license associated to the package
💻 Examples
"Apache-2.0"
👀 See Also
@type t() :: %Aura.Model.HexPackageMeta{ description: package_description(), licenses: [software_license()], links: %{required(String.t()) => meta_url()}, maintainers: [Aura.Common.username()] }
Type describing additional metadata about a Aura.Model.HexPackage
🏷️ Keys
- maintainers :: [
Aura.Common.username/0
] - links :: [
meta_url/0
] - licenses :: [
software_license/0
] - description ::
package_description/0
💻 Examples
%Aura.Model.HexPackageMeta{
maintainers: [],
links: %{"GitHub" => "https://github.com/michalmuskala/jason"},
licenses: ["Apache-2.0"],
description: "A blazing fast JSON parser and generator in pure Elixir."
}
👀 See Also
Functions
Builds a HexPackageMeta
from a map
🏷️ Params
- m :: A map to build into a
Aura.Model.HexPackageMeta.t/0