rr
random-reddit
npm i random-reddit
rr

random-reddit

Random Reddit posts and images

by Alex

2.0.3 (see all)License:MITTypeScript:Built-InCategories:Vanilla JavaScript Reddit API
npm i random-reddit
Readme

Random Reddit npm

The set of functions that get random posts or images from specified subreddit.

Usage

Installation

  1. npm install random-reddit
  2. Use getPost() or getImage() from the package.

Example

const { getPost, getImage } = require('random-reddit')

function async getPost() {
  const post = await getPost('memes')
  console.log(post) // returns the reddit post object
  // ...
}

function async getImage() {
  const image = await getImage('memes')
  console.log(image) // e.g. https://i.redd.it/sri113wns9351.png
}

Logs

You can enable inner logs by setting the environment variable RANDOM_REDDIT_LOG_LEVEL to a number from -1 (no logs at all) to 5 (every log possible).

RANDOM_REDDIT_LOG_LEVEL=4 node my_app.js

The logs are provided by the consola package. So the log level can also be changed with CONSOLA_LEVEL env variable

CONSOLA_LEVEL=4 node my_app.js

Typings

Types are provided by the reddit-interfaces package. It's the peer dependency, so it you have to install it manually, if you use random-reddit with Typescript.

Functions

getPost()

getPost(subreddit: string | string[]): Promise

Returns the whole Reddit post.

Arguments:

  • subreddit (string | string[]) - a subreddit to fetch the post from. You can also specify an array of subreddit names. Make sure there's no r/ part in the value(s)

getImage()

getImage(subreddit: string | string[], retryLimit?: number): Promise

Returns the random post's image URL. If it won't find one - the request will be sent again until the retryLimit is reached.

Arguments:

  • subreddit (string | string[]) - a subreddit to fetch the image from. You can also specify an array of subreddit names
  • retryLimit (number) - optional. Request retry limit. Default is 10.

getPostById()

getPostById(id: string, subreddit: string): Promise

Returns specific post with given id (ID36) and specified subreddit.

Arguments:

  • id (string) - post's id
  • subreddit (string) - a subreddit to fetch the post from

Downloads/wk

93

GitHub Stars

1

LAST COMMIT

NaNyrs ago

MAINTAINERS

1

CONTRIBUTORS

0

OPEN ISSUES

2

OPEN PRs

0
VersionTagPublished
2.0.3
latest
6mos ago
2.0.2-2
next
10mos ago
No tutorials found
Add a tutorial