No description

Find a file

Renovate Bot 89479873b8 All checks were successful Stage / build (push) Successful in 8s Details Stage / rsync (push) Successful in 7s Details Update dependency got to v14.4.2 (#217 ) This PR contains the following updates: \| Package \| Type \| Update \| Change \| \|---\|---\|---\|---\| \| [got](https://github.com/sindresorhus/got) \| resolutions \| minor \| [`14.0.0` -> `14.4.2`](https://renovatebot.com/diffs/npm/got/14.0.0/14.4.2) \| --- ### Release Notes <details> <summary>sindresorhus/got (got)</summary> ### [`v14.4.2`](https://github.com/sindresorhus/got/releases/tag/v14.4.2) [Compare Source](https://github.com/sindresorhus/got/compare/v14.4.1...v14.4.2) - Fix handling of invalid arguments ([#2367](https://github.com/sindresorhus/got/issues/2367)) [`f44ef43`](https://github.com/sindresorhus/got/commit/f44ef43) ### [`v14.4.1`](https://github.com/sindresorhus/got/releases/tag/v14.4.1) [Compare Source](https://github.com/sindresorhus/got/compare/v14.4.0...v14.4.1) - Fix missing dependency [`dfc54d9`](https://github.com/sindresorhus/got/commit/dfc54d9) ### [`v14.4.0`](https://github.com/sindresorhus/got/releases/tag/v14.4.0) [Compare Source](https://github.com/sindresorhus/got/compare/v14.3.0...v14.4.0) - Improve TypeScript types with generic extend ([#2353](https://github.com/sindresorhus/got/issues/2353)) [`15ca4a0`](https://github.com/sindresorhus/got/commit/15ca4a0) ### [`v14.3.0`](https://github.com/sindresorhus/got/releases/tag/v14.3.0) [Compare Source](https://github.com/sindresorhus/got/compare/v14.2.1...v14.3.0) - Update dependencies [`dbab6c3`](https://github.com/sindresorhus/got/commit/dbab6c3) ### [`v14.2.1`](https://github.com/sindresorhus/got/releases/tag/v14.2.1) [Compare Source](https://github.com/sindresorhus/got/compare/v14.2.0...v14.2.1) - Fix error handling when UTF-8 decoding fails ([#2336](https://github.com/sindresorhus/got/issues/2336)) [`c81a611`](https://github.com/sindresorhus/got/commit/c81a611) ### [`v14.2.0`](https://github.com/sindresorhus/got/releases/tag/v14.2.0) [Compare Source](https://github.com/sindresorhus/got/compare/v14.1.0...v14.2.0) - Add `cause` property with the original error to `RequestError` ([#2327](https://github.com/sindresorhus/got/issues/2327)) [`4cbd01d`](https://github.com/sindresorhus/got/commit/4cbd01d) ### [`v14.1.0`](https://github.com/sindresorhus/got/releases/tag/v14.1.0) [Compare Source](https://github.com/sindresorhus/got/compare/v14.0.0...v14.1.0) - Allow typing the body of a `RequestError` response ([#2325](https://github.com/sindresorhus/got/issues/2325)) [`5e4f6ff`](https://github.com/sindresorhus/got/commit/5e4f6ff) </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:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjQzMS40IiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6WyJ0eXBlL2RlcGVuZGVuY2llcyJdfQ==--> Reviewed-on: #217 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>		2024-09-02 18:38:56 +01:00
.forgejo/workflows	Update forgejo actions workflow to rsync to the server on push to master/develop (#207 )	2024-08-02 17:44:43 +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 the post author to the return result (#208 )	2024-08-02 17:47:47 +01:00
src	Update pkg version to 2.3	2024-08-07 17:12:10 +01:00
tests	Add the post author to the return result (#208 )	2024-08-02 17:47:47 +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
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	v2.3.0	2024-08-07 17:13:56 +01:00
readme.md	Add the post author to the return result (#208 )	2024-08-02 17:47:47 +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	Update dependency got to v14.4.2 (#217 )	2024-09-02 18:38:56 +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 3 arguments: subreddit, sortby ('new', 'hot', 'top'), and limit (1-100, default 100)

The json string which gets returned consists of:

archived
author
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