RabbitLabs/random-bunny
4
0
Fork 0
Code Issues 20 Pull requests 5 Actions Projects 1 Releases 17 Wiki Activity
49 commits 8 branches 19 tags 21 MiB
TypeScript 99.4%
JavaScript 0.6%
Go to file
Vylpes 031a5455b5 hotfix/2.0.3 (#41) 
- Bump minimatch from 3.0.4 to 3.1.2
- Update discord links

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/41
Reviewed-by: VylpesTester <tester@vylpes.com>
2022-12-18 15:27:03 +00: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 hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00:00
.drone.yml hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00: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 hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00:00
CONTRIBUTING.md hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +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 hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00:00
readme.md hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00:00
tsconfig.json hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00:00
yarn.lock hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00: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

Links

License

MIT © Vylpes