Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arifszn/reddit-image-fetcher
A JavaScript package for fetching reddit images, memes, wallpapers and more.
https://github.com/arifszn/reddit-image-fetcher
memes reddit reddit-api wallpapers
Last synced: 2 months ago
JSON representation
A JavaScript package for fetching reddit images, memes, wallpapers and more.
- Host: GitHub
- URL: https://github.com/arifszn/reddit-image-fetcher
- Owner: arifszn
- License: mit
- Created: 2020-09-27T10:24:41.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-07-26T16:11:41.000Z (over 1 year ago)
- Last Synced: 2024-10-28T13:54:35.288Z (2 months ago)
- Topics: memes, reddit, reddit-api, wallpapers
- Language: JavaScript
- Homepage: https://arifszn.github.io/reddit-image-fetcher
- Size: 4.86 MB
- Stars: 44
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Reddit Image Fetcher
A JavaScript package for fetching reddit images, memes, wallpapers and more.
Reddit Image Fetcher is a JavaScript package that can fetch bulk images, memes or wallpapers. Supports node, react and other any JavaScript language.
- Bulk images
- Bulk memes
- Bulk wallpapers
- Customizable
- Lightweight<20KB
> PHP version: Reddit Image Fetcher
## Resources
- [Demo](https://memedb.netlify.app)
- [Documentation](https://arifszn.github.io/reddit-image-fetcher)
- [CodeSandbox](https://codesandbox.io/s/reddit-image-fetcher-53x89)## Installation
Install via NPM
```
npm install reddit-image-fetcher
```Install via Yarn
```
yarn add reddit-image-fetcher
```## Usage
```js
const RedditImageFetcher = require('reddit-image-fetcher');// fetch 1 meme
RedditImageFetcher.fetch({
type: 'meme',
}).then((result) => {
console.log(result);
});// fetch 1 wallpaper
RedditImageFetcher.fetch({
type: 'wallpaper',
}).then((result) => {
console.log(result);
});// fetch 50 wallpapers
RedditImageFetcher.fetch({
type: 'wallpaper',
total: 50,
}).then((result) => {
console.log(result);
});// fetch 50 cat images from custom subreddit library
RedditImageFetcher.fetch({
type: 'custom',
total: 50,
subreddit: ['cats', 'Catswhoyell', 'sleepingcats'],
}).then((result) => {
console.log(result);
});// fetch 50 memes by adding two subreddits and removing 1 subreddit from default subreddit library
RedditImageFetcher.fetch({
type: 'custom',
total: 50,
addSubreddit: ['memes', 'funny'],
removeSubreddit: ['dankmemes'],
}).then((result) => {
console.log(result);
});
```## Sample Response
```js
[
{
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'
\|'custom'
|'meme'
|
| total | number | How many images to get. Max is 50 |1
|
| subreddit | [string] | Custom subreddit library |[ ]
|
| addSubreddit | [string] | Add subreddits to subreddit library |[ ]
|
| removeSubreddit | [string] | Remove subreddits from subreddit library |[ ]
|
| allowNSFW | boolean | Allow NSFW results |true
|## Support
You can show your support by starring this project.
## Contribute
To contribute, see the [contributing guide](https://github.com/arifszn/reddit-image-fetcher/blob/main/CONTRIBUTING.md).
## License
[MIT License](https://github.com/arifszn/reddit-image-fetcher/blob/main/LICENSE)