Go to file

Vylpes 1d26026b1a Add .drone.yml (#32 ) Co-authored-by: Ethan Lane <ethan@vylpes.com> Reviewed-on: https://gitea.vylpes.xyz/Vylpes/random-bunny/pulls/32		2022-08-05 15:24:55 +01:00
.github	Create FUNDING.yml	2021-05-10 21:50:20 +01:00
.gitlab	Update default.md	2021-01-15 18:15:14 +00:00
src	Make sortBy optional	2021-12-01 20:53:45 +00:00
.drone.yml	Add .drone.yml (#32 )	2022-08-05 15:24:55 +01:00
.eslintrc	Update .eslintrc	2021-01-16 22:16:20 +00:00
.gitignore	Replace fetch with got	2021-12-01 20:39:02 +00:00
.gitlab-ci.yml	Add aslant to gitlab project ci	2021-01-13 21:08:47 +00:00
.npmignore	rewrite in typescript	2021-12-01 20:32:20 +00:00
app.ts	rewrite in typescript	2021-12-01 20:32:20 +00:00
CODE_OF_CONDUCT.md	Resolve "Create documentation"	2021-01-13 20:38:31 +00:00
CONTRIBUTING.md	Resolve "Create documentation"	2021-01-13 20:38:31 +00:00
license	Resolve "Create documentation"	2021-01-13 20:38:31 +00:00
LICENSE	Resolve "Create documentation"	2021-01-13 20:38:31 +00:00
package.json	v2.0.1	2022-07-14 17:35:36 +01:00
readme.md	Update documentation	2021-12-01 20:53:53 +00:00
tsconfig.json	Update tsconfig	2021-12-02 10:11:34 +00:00
yarn.lock	Bump glob-parent from 6.0.0 to 6.0.1 (#29 )	2022-08-04 18:05:46 +01:00

readme.md

random-bunny

Get a random image url from a subreddit of your choosing.

Install

npm install --save random-bunny

or if you're using yarn

yarn add random-bunny

Usage

import randomBunny from "random-bunny";

// ... In an async function
const result = await randomBunny('rabbits', 'hot', 100);
console.log(result);

API

`randomBunny()`

Returns a json string for a random post. Accepts 3 arguments: subreddit, sortby ('new', 'hot', 'top'), maxTries? (default 100)

The json string which gets returned consists of:

archived
downs
hidden
permalink
subreddit
subredditSubscribers
title
ups
url

sortBy will default to 'hot' if not given or invalid

maxTries prevents the script from rerolling too many times. The script rerolls the randomiser if the post its given doesn't contain an image. Default 100.

Notes

Node 4 or newer.
based upon Random Puppy