Aura.Model.HexPackageOwner (Aura v0.9.0)

View Source

A struct describing an owner of a Aura.Model.HexPackage

Summary

Types

The user's full name (e.g "Jane Smith")

The user's administration level for this package

A map of social media handles owned by this user

t()

Type describing an owner of a Aura.Model.HexPackage

Functions

Builds a HexPackageOwner from a map

Types

full_name()

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

The user's full name (e.g "Jane Smith")

level()

@type level() :: :full | :maintainer

The user's administration level for this package

social_handles()

@type social_handles() :: %{
  elixir_form: URI.t(),
  git_hub: URI.t(),
  twitter: URI.t(),
  slack: URI.t(),
  libera: String.t()
}

A map of social media handles owned by this user

t()

@type t() :: %Aura.Model.HexPackageOwner{
  email: Aura.Common.email(),
  full_name: full_name(),
  handles: social_handles(),
  inserted_at: Aura.Model.Common.inserted_at(),
  level: level(),
  updated_at: Aura.Model.Common.updated_at(),
  url: Aura.Model.Common.url(),
  username: Aura.Common.username()
}

Type describing an owner of a Aura.Model.HexPackage

🏷️ Keys

Functions

build(m)

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

Builds a HexPackageOwner from a map