No description

Find a file

Renovate Bot fecff96604 All checks were successful ci/woodpecker/push/woodpecker Pipeline was successful Details Update dependency jest-mock-extended to v3.0.6 (#163 ) This PR contains the following updates: \| Package \| Type \| Update \| Change \| \|---\|---\|---\|---\| \| [jest-mock-extended](https://github.com/marchaos/jest-mock-extended) \| devDependencies \| patch \| [`3.0.5` -> `3.0.6`](https://renovatebot.com/diffs/npm/jest-mock-extended/3.0.5/3.0.6) \| --- ### Release Notes <details> <summary>marchaos/jest-mock-extended (jest-mock-extended)</summary> ### [`v3.0.6`](https://github.com/marchaos/jest-mock-extended/compare/3.0.5...77a64ae8328904bcc614ead4ba8d0d9e8a658136) [Compare Source](https://github.com/marchaos/jest-mock-extended/compare/3.0.5...77a64ae8328904bcc614ead4ba8d0d9e8a658136) </details> --- ### Configuration 📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied. ♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 Ignore: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=--> Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/163 Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>		2024-04-15 18:27:39 +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 documentation on the cli (#149 )	2024-02-23 18:30:56 +00:00
src	Merge branch 'master' into develop	2024-04-12 18:05:00 +01:00
tests	Fix tests	2024-04-12 18:13:04 +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	Add binary building (#151 )	2024-03-01 19:51:12 +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	2024-04-12 18:05:00 +01:00
readme.md	Add documentation on the cli (#149 )	2024-02-23 18:30:56 +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 jest-mock-extended to v3.0.6 (#163 )	2024-04-15 18:27:39 +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

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

Node 4 or newer.
based upon Random Puppy