Convenience functions for the GitHub Users REST API.
Thin wrappers over GhEx.REST that return the same {:ok, body, meta} /
{:error, reason} shape; opts pass through to Req.
Summary
Functions
Gets a user by username.
Gets the authenticated user.
Lists email addresses for the authenticated user.
Lists followers of a user.
Lists users followed by a user.
Auto-paginates the authenticated user's email addresses into a lazy Stream.
Auto-paginates a user's followers into a lazy Stream (see GhEx.REST.stream/3).
Auto-paginates the users a user follows into a lazy Stream.
Functions
@spec get(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Gets a user by username.
@spec get_authenticated( GhEx.Client.t(), keyword() ) :: GhEx.REST.result()
Gets the authenticated user.
@spec list_emails( GhEx.Client.t(), keyword() ) :: GhEx.REST.result()
Lists email addresses for the authenticated user.
@spec list_followers(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Lists followers of a user.
@spec list_following(GhEx.Client.t(), String.t(), keyword()) :: GhEx.REST.result()
Lists users followed by a user.
@spec stream_emails( GhEx.Client.t(), keyword() ) :: Enumerable.t()
Auto-paginates the authenticated user's email addresses into a lazy Stream.
@spec stream_followers(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates a user's followers into a lazy Stream (see GhEx.REST.stream/3).
@spec stream_following(GhEx.Client.t(), String.t(), keyword()) :: Enumerable.t()
Auto-paginates the users a user follows into a lazy Stream.