Reddit Image Fetcher

A JavaScript package for fetching reddit images, memes, wallpapers and more.

https://arifszn.github.io/reddit-image-fetcher

Bulk images
Bulk memes
Bulk wallpapers
Customizable
Lightweight <20KB

Resources
Installation
Usage
Result
Options
Support
License

Resources

Installation

Install via NPM

npm install --save reddit-image-fetcher

Install via Yarn

yarn add reddit-image-fetcher

Usage

Available function:

fetch()

//use with await
await redditImageFetcher.fetch({type: 'meme'}); //returns 1 meme 
await redditImageFetcher.fetch({type: 'wallpaper'}); //returns 1 wallpaper


//use with callback
redditImageFetcher.fetch({type: 'meme'})
.then(result => { }); //returns 1 meme


//options
await redditImageFetcher.fetch({ type: 'wallpaper', total: 50 }); //returns 50 wallpapers 
 
await redditImageFetcher.fetch({
    type: 'meme',
    total: 50, 
    addSubreddit: ['memes', 'funny'], 
    removeSubreddit: ['dankmemes']
}); //returns 50 memes by filtering


//custom image fetch from given subreddits
await redditImageFetcher.fetch({
    type: 'custom',
    total: 50, 
    subreddit: ['cats', 'Catswhoyell', 'sleepingcats'] 
}); //returns 50 cat images

Result

The functions are asynchronous and return array.

[
  {
    id: "hfh51v",
    type: "wallpaper",
    title: "Illuminated City at Night [1920 x 1200]",
    postLink: "https://redd.it/hfh51v",
    image: "https://i.redd.it/b6x9i2n830751.jpg",
    thumbnail: "https://b.thumbs.redditmedia.com/mLCk8Bh0N4M8hZafHsbAmw8rM7JEEznsT2nRZSo3GsU.jpg",
    subreddit: "wallpaper",
    NSFW: false,
    spoiler: false,
    createdUtc: 1593066557,
    upvotes: 1899,
    upvoteRatio: 1.0
  },
  {
    id: "h9glhi",
    type: "wallpaper",
    title: "Missing Home by Just Jaker",
    postLink: "https://redd.it/h9glhi",
    image: "https://cdnb.artstation.com/p/assets/images/images/027/020/665/large/just-jaker-galax-noise.jpg",
    thumbnail: "https://b.thumbs.redditmedia.com/4utBLNbsIDDLl46z494PCRkDhmAnapQq9FL7l-07aJo.jpg",
    subreddit: "ImaginaryFuturism",
    NSFW: false,
    spoiler: false,
    createdUtc: 1592228591,
    upvotes: 462,
    upvoteRatio: 1.0
  }
]

Options

Property	Type	Description	Default
type	string	meme, wallpaper or custom image to fetch	'meme'
total	number	How many images to get. Max is 50	1
subreddit	[string]	Custom subreddit libray	[ ]
addSubreddit	[string]	Add subreddits to subreddit library	[ ]
removeSubreddit	[string]	Remove subreddits from subreddit library	[ ]

Support

Show your ❤️ and support by giving a ⭐ on Github.

License

MIT Licensed.

MeltyMoon/reddit-image-fetcher