Aura.Model.HexPackageMeta (Aura v1.0.1)

View Source

A 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."
}

Resources

See Also

Summary

Types

additional_links()

Additional URLs associated with the Hex package

meta_url()

Additional external URL relating to the package

package_description()

Short, human-readable description of the package

software_license()

The software license associated to the package

t()

Type describing additional metadata about a Aura.Model.HexPackage

Functions

build(m)

Builds a HexPackageMeta from a map

Types

additional_links()

@type additional_links() :: %{required(String.t()) => meta_url()}

Additional URLs associated with the Hex package

Examples

%{"GitHub" => "https://github.com/michalmuskala/jason"}

See Also

meta_url()

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

Additional external URL relating to the package

Examples

"https://github.com/michalmuskala/jason"

See Also

package_description()

@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

software_license()

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

The software license associated to the package

Examples

"Apache-2.0"

See Also

t()

@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

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

build(m)

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

Builds a HexPackageMeta from a map

Parameters

ParameterDescription
mA map to build into a Aura.Model.HexPackageMeta.t/0