RabbitLabs/random-bunny
4
0
Fork 0
Code Issues 10 Pull requests 9 Projects 1 Releases 18 Wiki Activity Actions
No description
187 commits 12 branches 20 tags 33 MiB
TypeScript 95.8%
JavaScript 4.2%
Find a file
Renovate Bot 44417d8f46
All checks were successful
Test / build (push) Successful in 7s
Details
Update actions/setup-node action to v4
2024-07-07 23:03:19 +00:00
.forgejo/workflows Update actions/setup-node action to v4 2024-07-07 23:03:19 +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
docs Fix the unit test toBeCalledWith deprecated warnings (#182) 2024-06-22 10:09:55 +01:00
src Fix the unit test toBeCalledWith deprecated warnings (#182) 2024-06-22 10:09:55 +01:00
tests Fix the unit test toBeCalledWith deprecated warnings (#182) 2024-06-22 10:09:55 +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 binary building (#151) 2024-03-01 19:51:12 +00:00
.gitlab-ci.yml Add aslant to gitlab project ci 2021-01-13 21:08:47 +00:00
.npmignore Add binary building (#151) 2024-03-01 19:51:12 +00:00
.woodpecker.yml Update rsync ip 2024-04-19 18:34:25 +01: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 Update dependency np to v10 (#159) 2024-06-10 17:22:24 +01:00
readme.md Update documentation to mention about the binary files (#167) 2024-04-19 18:30:12 +01: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 commander to v12.1.0 (#176) 2024-06-10 17:33:25 +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

Binary

The project can be downloaded as a binary for your system via the GitHub Releases or Gitea Releases page.

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

CLI

Random bunny can also be used as a CLI. This is accessible via the executable (see git releases) or via src/cli.ts

For more details, see the documentation.

Notes

Links

License

MIT © Vylpes