Find a file

RenovateBot 2e20a6f3e4 All checks were successful Stage / build (push) Successful in 8s Details Stage / rsync (push) Successful in 8s Details Update dependency @yao-pkg/pkg to v5.13.0 (#216 ) This PR contains the following updates: \| Package \| Type \| Update \| Change \| \|---\|---\|---\|---\| \| [@yao-pkg/pkg](https://github.com/yao-pkg/pkg) \| devDependencies \| minor \| [`5.12.0` -> `5.13.0`](https://renovatebot.com/diffs/npm/@yao-pkg%2fpkg/5.12.0/5.13.0) \| --- ### Release Notes <details> <summary>yao-pkg/pkg (@yao-pkg/pkg)</summary> ### [`v5.13.0`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5130-2024-09-06) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.12.1...v5.13.0) ##### Features - bump pkg-fetch@3.5.10 with node 20.17.0 and 18.20.4 support ([dda9032](`dda90320fc`)) ##### Bug Fixes - wrong placeholder replaced in windows binary ([#86](https://github.com/yao-pkg/pkg/issues/86)) ([d9b28c3](`d9b28c391b`)) ### [`v5.12.1`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5121-2024-08-14) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.12.0...v5.12.1) ##### Bug Fixes - remove `is-core-module` dependency ([#77](https://github.com/yao-pkg/pkg/issues/77)) ([2f27414](`2f27414d5d`)) - run prebuild-install only if actually used by the package ([#83](https://github.com/yao-pkg/pkg/issues/83)) ([2a046e4](`2a046e4be3`)) ##### Chores - drop package-lock file uploaded by error ([ba407ef](`ba407efef1`)) </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: #216 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>		2024-09-10 19:56:34 +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	Remove macOS build support (#224 )	2024-09-07 16:12:27 +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	Remove macOS build support (#224 )	2024-09-07 16:12:27 +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 @yao-pkg/pkg to v5.13.0 (#216 )	2024-09-10 19:56:34 +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