gleam/hexpm

Types

Package

Information on a package from Hex’s /api/packages endpoint.

pub type Package {
  Package(
    name: String,
    html_url: Option(String),
    docs_html_url: Option(String),
    meta: PackageMeta,
    downloads: Dict(String, Int),
    owners: Option(List(PackageOwner)),
    releases: List(PackageRelease),
    inserted_at: Time,
    updated_at: Time,
  )
}

Constructors

Package(
  name: String,
  html_url: Option(String),
  docs_html_url: Option(String),
  meta: PackageMeta,
  downloads: Dict(String, Int),
  owners: Option(List(PackageOwner)),
  releases: List(PackageRelease),
  inserted_at: Time,
  updated_at: Time,
)

PackageMeta

</>

pub type PackageMeta {
  PackageMeta(
    links: Dict(String, String),
    licenses: List(String),
    description: Option(String),
  )
}

Constructors

PackageMeta(
  links: Dict(String, String),
  licenses: List(String),
  description: Option(String),
)

PackageOwner

</>

pub type PackageOwner {
  PackageOwner(
    username: String,
    email: Option(String),
    url: String,
  )
}

Constructors

PackageOwner(
  username: String,
  email: Option(String),
  url: String,
)

PackageRelease

</>

pub type PackageRelease {
  PackageRelease(version: String, url: String, inserted_at: Time)
}

Constructors

PackageRelease(version: String, url: String, inserted_at: Time)

Release

</>

Information on a release from Hex’s /api/packages/:name/releases/:version endpoint.

pub type Release {
  Release(
    version: String,
    url: String,
    checksum: String,
    downloads: Int,
    publisher: Option(PackageOwner),
    meta: ReleaseMeta,
    retirement: Option(ReleaseRetirement),
    inserted_at: Time,
    updated_at: Time,
  )
}

Constructors

Release(
  version: String,
  url: String,
  checksum: String,
  downloads: Int,
  publisher: Option(PackageOwner),
  meta: ReleaseMeta,
  retirement: Option(ReleaseRetirement),
  inserted_at: Time,
  updated_at: Time,
)

ReleaseMeta

</>

Meta for a hex release

pub type ReleaseMeta {
  ReleaseMeta(app: Option(String), build_tools: List(String))
}

Constructors

ReleaseMeta(app: Option(String), build_tools: List(String))

ReleaseRetirement

</>

pub type ReleaseRetirement {
  ReleaseRetirement(
    reason: RetirementReason,
    message: Option(String),
  )
}

Constructors

ReleaseRetirement(
  reason: RetirementReason,
  message: Option(String),
)

RetirementReason

</>

pub type RetirementReason {
  OtherReason
  Invalid
  Security
  Deprecated
  Renamed
}

Constructors

```
OtherReason
```
```
Invalid
```
```
Security
```
```
Deprecated
```
```
Renamed
```

Functions

decode_package

</>

pub fn decode_package(
  data: Dynamic,
) -> Result(Package, List(DecodeError))

decode_release

</>

pub fn decode_release(
  data: Dynamic,
) -> Result(Release, List(DecodeError))

decode_retirement_reason

</>

pub fn decode_retirement_reason(
  data: Dynamic,
) -> Result(RetirementReason, List(DecodeError))

retirement_reason_to_string

</>

pub fn retirement_reason_to_string(
  reason: RetirementReason,
) -> String