GitHub.Issues (GitHub Issues v0.4.59)

View Source

Fetches a list of issues from a GitHub project.

Summary

Types

GitHub issue

Functions

Fetches issues from the GitHub project of a given user.

Types

issue()

@type issue() :: map()

GitHub issue

Functions

fetch(user, project)

@spec fetch(GitHub.Issues.CLI.user(), GitHub.Issues.CLI.project()) ::
  {:ok, [issue()]} | {:error, String.t()}

Fetches issues from the GitHub project of a given user.

Returns a tuple of either {:ok, [issue]} or {:error, text}.

Examples

iex> alias GitHub.Issues
iex> {:ok, issues} = Issues.fetch("Kraigie", "nostrum")
iex> Enum.all?(issues, &is_map/1) and length(issues) > 0
true