RabbitLabs/random-bunny
4
0
Fork 0
Code Issues 11 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions
No description
115 commits 14 branches 20 tags 34 MiB
TypeScript 95.8%
JavaScript 4.2%
Find a file
Renovate Bot b721f9458b
All checks were successful
continuous-integration/drone/push Build is passing
Details
Update dependency eslint to v8.51.0
2023-10-08 23:02:31 +00:00
.gitea Add Gitea templates 2023-02-24 17:33:39 +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 Add error codes and error messages to failed results (#89) 2023-09-15 15:18:57 +01:00
tests Add error codes and error messages to failed results (#89) 2023-09-15 15:18:57 +01:00
.drone.yml Add push event to .drone.yml 2023-04-29 14:43:47 +01:00
.eslintignore Setup Jest (#57) 2023-04-22 13:20:30 +01:00
.eslintrc Setup Jest (#57) 2023-04-22 13:20:30 +01:00
.gitignore Add error codes and error messages to failed results (#89) 2023-09-15 15:18:57 +01:00
.gitlab-ci.yml Add aslant to gitlab project ci 2021-01-13 21:08:47 +00:00
.npmignore Setup Jest (#57) 2023-04-22 13:20:30 +01:00
app.ts Update project to allow for ESM modules 2023-02-27 18:33:32 +00:00
CODE_OF_CONDUCT.md Update documentation with up to date information 2022-08-18 17:45:05 +01:00
CONTRIBUTING.md Fix documentation code breaks (#58) 2023-04-28 17:31:34 +01:00
jest.config.cjs Setup Jest (#57) 2023-04-22 13:20:30 +01:00
jest.setup.js Setup Jest (#57) 2023-04-22 13:20:30 +01:00
LICENSE Update licence copyright to 2023 (#59) 2023-04-28 17:31:55 +01:00
package.json Merge branch 'master' into develop 2023-09-13 13:20:07 +01:00
readme.md Updatr documentation to remove maxTries variable 2023-02-22 18:19:47 +00:00
renovate.json Update 'renovate.json' 2022-12-28 18:43:41 +00:00
tsconfig.json Setup Jest (#57) 2023-04-22 13:20:30 +01:00
yarn.lock Update dependency eslint to v8.51.0 2023-10-08 23:02:31 +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');
console.log(result);

API

randomBunny()

Returns a json string for a random post. Accepts 2 arguments: subreddit, and sortby ('new', 'hot', 'top')

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

Notes

Links

License

MIT © Vylpes