No description
Find a file
Vylpes 77298dbd61
All checks were successful
Test / build (push) Successful in 8s
Merge branch 'develop' into renovate/typescript-5.x-lockfile
2024-07-29 17:48:23 +01:00
.forgejo/workflows Update actions/setup-node action to v4 (#192) 2024-07-22 18:00:37 +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
docs Add new limit option to limit the requested amount of posts from the Reddit API (#203) 2024-07-26 18:23:19 +01:00
src Add new limit option to limit the requested amount of posts from the Reddit API (#203) 2024-07-26 18:23:19 +01:00
tests Add new limit option to limit the requested amount of posts from the Reddit API (#203) 2024-07-26 18:23:19 +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 hotfix/2.0.3 (#41) 2022-12-18 15:27:03 +00:00
CONTRIBUTING.md Fix documentation code breaks (#58) 2023-04-28 17:31:34 +01:00
eslint.config.mjs Update eslint (#198) 2024-07-26 18:21:28 +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 Move to a fork of pkg (#202) 2024-07-26 18:26:58 +01:00
readme.md Add new limit option to limit the requested amount of posts from the Reddit API (#203) 2024-07-26 18:23:19 +01:00
renovate.json Add type/dependency label to renovate config (#197) 2024-07-26 18:19:44 +01:00
tsconfig.json Setup Jest (#57) 2023-04-22 13:20:30 +01:00
yarn.lock Merge branch 'develop' into renovate/typescript-5.x-lockfile 2024-07-29 17:48:23 +01:00

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 3 arguments: subreddit, sortby ('new', 'hot', 'top'), and limit (1-100, 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

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

License

MIT © Vylpes