@blad3mak3r/reddit-memes

Reddit Memes

A small async wrapper to get reddit memes (post with images) from the best Reddits memes, this project is actively used as API by HUGE in HugeMemesAPI

You can also get this package for other programming languages:

Packages
Java
Node.js
Deno

Getting started

How to install

Inside your npm project run the following command

npm install @blad3mak3r/reddit-memes --save

Or

npm i -S @blad3mak3r/reddit-memes

Compile and test it yourself

1. Fork this repository.

2. Clone your repository.

git clone https://github.com/<YOUR_USERNAME_HERE>/RedditMemes.git

3. Access the repository folder and install the dependencies.

cd RedditMemes
npm install

4. Compile the project.

npm run build

5. Test the project.

npm run test

6. Run the examples.

npm run examples

7. Enjoy

You can see how this project works by watching the live demo.

How to use

This package is perfect if you are using TypeSript in your project since it includes all the necessary definitions to avoid errors.

Import the package

import { getRandomMeme, getLocalRandomMeme } from '@blad3mak3r/reddit-memes';

import * as memes from '@blad3mak3r/reddit-memes';

Get a random meme Async/Await

getRandomMeme().then(console.info).catch(console.error);

Get a random meme from a SubReddit Async/Await

getRandomMeme("memes").then(console.info).catch(console.error);

Filter NSFW posts (by default allowNSFW is set to false)

// Prevent NSFW
getRandomMeme("meme", { allowNSFW: false }).then(console.log).catch(console.error);

// Prevent NSFW
getLocalRandomMeme("es", { allowNSFW: false }).then(console.info).catch(console.error);

getRandomMeme(/* some NSFW reddit */, { allowNSFW: true }).then(console.info).catch(console.error);

Get country based random meme Async/Await

The country codes supported at the moment are en, es, fr, ru, de, it.

getLocalRandomMeme("es").then(console.info).catch(console.error);

License

This project is under the Apache 2.0 license, read license.