RabbitLabs/random-bunny
5
0
Fork 0
Code Issues 11 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions
No description
88 commits 14 branches 20 tags 34 MiB
TypeScript 95.8%
JavaScript 4.2%
Find a file
Vylpes 2ab2fe04fd
All checks were successful
continuous-integration/drone/push Build is passing
Details
Merge pull request 'Update dependency typescript to v5' (#55) from renovate/typescript-5.x into develop 
Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/55
2023-04-17 17:34:24 +01: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 Update project to allow for ESM modules 2023-02-27 18:33:32 +00:00
.drone.yml Add renovate to pipelines 2023-02-27 18:34:31 +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 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 hotfix/2.0.3 (#40) 2022-12-18 15:26:53 +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 Merge pull request 'Update dependency typescript to v5' (#55) from renovate/typescript-5.x into develop 2023-04-17 17:34:24 +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 Update project to allow for ESM modules 2023-02-27 18:33:32 +00:00
yarn.lock Merge pull request 'Update dependency typescript to v5' (#55) from renovate/typescript-5.x into develop 2023-04-17 17:34:24 +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');
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