reddex

v0.1.0

reddex v0.1.0 Reddex.API.Subreddit View Source

Functions for subreddits.

Link to this section Summary

Functions

about(subreddit)

Retrieves information about a subreddit

controversial(subreddit, opts \\ [])

Retrieves controversial posts from a subreddit. See here for options

hot(subreddit, opts \\ [])

Retrieves hot posts from a subreddit. See here for options

new(subreddit, opts \\ [])

Retrieves new posts from a subreddit. See here for options

top(subreddit, opts \\ [])

Retrieves top posts from a subreddit. See here for options

Link to this section Functions

Link to this function

about(subreddit) View Source 
about(String.t()) :: {:ok, map()} | Reddex.HTTP.error()

Retrieves information about a subreddit.

Link to this function

controversial(subreddit, opts \\ []) View Source 
controversial(String.t(), keyword()) :: Reddex.HTTP.listing_resp()

Retrieves controversial posts from a subreddit. See here for options.

Link to this function

hot(subreddit, opts \\ []) View Source 
hot(String.t(), keyword()) :: Reddex.HTTP.listing_resp()

Retrieves hot posts from a subreddit. See here for options.

Link to this function

new(subreddit, opts \\ []) View Source 
new(String.t(), keyword()) :: Reddex.HTTP.listing_resp()

Retrieves new posts from a subreddit. See here for options.

Link to this function

top(subreddit, opts \\ []) View Source 
top(String.t(), keyword()) :: Reddex.HTTP.listing_resp()

Retrieves top posts from a subreddit. See here for options.