Convenience functions for the GitHub Search REST API.
Each function takes the search query (the q parameter) and returns the same
{:ok, body, meta} / {:error, reason} shape as GhEx.REST. Pass
params: [sort: ..., order: ..., per_page: ...] for the other search options;
q is merged in.
Summary
Functions
Searches code.
Searches commits.
Searches issues and pull requests.
Searches repositories.
Auto-paginates a code search into a lazy Stream, unwrapping "items".
Auto-paginates a commit search into a lazy Stream, unwrapping "items".
Auto-paginates an issue and pull request search into a lazy Stream, unwrapping "items".
Auto-paginates a repository search into a lazy Stream of individual results,
unwrapping the "items" array on each page (see GhEx.REST.stream/3).
Auto-paginates a user search into a lazy Stream, unwrapping "items".
Searches users.
Functions
@spec code(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Searches code.
@spec commits(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Searches commits.
@spec issues_and_pull_requests(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Searches issues and pull requests.
@spec repositories(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Searches repositories.
@spec stream_code(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates a code search into a lazy Stream, unwrapping "items".
@spec stream_commits(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates a commit search into a lazy Stream, unwrapping "items".
@spec stream_issues_and_pull_requests(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates an issue and pull request search into a lazy Stream, unwrapping "items".
@spec stream_repositories(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates a repository search into a lazy Stream of individual results,
unwrapping the "items" array on each page (see GhEx.REST.stream/3).
@spec stream_users(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates a user search into a lazy Stream, unwrapping "items".
@spec users(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Searches users.