Aura.Model.HexPackage (Aura v0.9.0)

View Source

A struct describing a package from a Hex-compliant API

Summary

Types

Whether this package is publicly available

The repository the package belongs to (e.g "hexpm")

t()

Type describing a package from a Hex-compliant API

Functions

Builds a HexPackage from a map

Types

private?()

@type private?() :: boolean()

Whether this package is publicly available

repository()

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

The repository the package belongs to (e.g "hexpm")

t()

@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: map(),
  repository: repository(),
  updated_at: Aura.Model.Common.updated_at(),
  url: Aura.Model.Common.url()
}

Type describing a package from a Hex-compliant API

🏷️ Keys

Functions

build(m)

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

Builds a HexPackage from a map