Find a file

RenovateBot ec2b5f1fc7 Some checks failed Stage / build (push) Successful in 9s Details Stage / rsync (push) Failing after 6s Details Update dependency @yao-pkg/pkg to v5.16.0 (#232 ) This PR contains the following updates: \| Package \| Type \| Update \| Change \| \|---\|---\|---\|---\| \| [@yao-pkg/pkg](https://github.com/yao-pkg/pkg) \| devDependencies \| minor \| [`5.13.0` -> `5.16.0`](https://renovatebot.com/diffs/npm/@yao-pkg%2fpkg/5.13.0/5.16.0) \| --- ### Release Notes <details> <summary>yao-pkg/pkg (@yao-pkg/pkg)</summary> ### [`v5.16.0`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5160-2024-10-20) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.15.0...v5.16.0) ##### Features - bump fetch with node 22.10.0 and 20.18.0 support ([86d5f57](`86d5f5797a`)) ##### Code refactoring - remove `fs-extra` ([#102](https://github.com/yao-pkg/pkg/issues/102)) ([c726221](`c726221de3`)) - replace `chalk` with `picocolors` ([#105](https://github.com/yao-pkg/pkg/issues/105)) ([cba291e](`cba291e246`)) - replace `globby` with `tinyglobby` ([#103](https://github.com/yao-pkg/pkg/issues/103)) ([99a2632](`99a26329cb`)) - replace `minimatch` with `picomatch` ([#104](https://github.com/yao-pkg/pkg/issues/104)) ([1838100](`183810066d`)) ##### Chores - unpin dependencies ([#106](https://github.com/yao-pkg/pkg/issues/106)) ([ea94b03](`ea94b03bad`)) ##### Documentation - explain how to execute binary from snapshot ([db7f2c5](`db7f2c5ede`)) - explain how to use custom binaries ([18ed3cf](`18ed3cfd1e`)) ### [`v5.15.0`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5150-2024-09-20) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.14.2...v5.15.0) ##### Features - bump [@yao-pkg/pkg-fetch](https://github.com/yao-pkg/pkg-fetch)[@3](https://github.com/3).5.13 with nodejs 22.9.0 ([#91](https://github.com/yao-pkg/pkg/issues/91)) ([6ed5665](`6ed566564f`)) ### [`v5.14.2`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5142-2024-09-17) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.14.1...v5.14.2) ##### Bug Fixes - child_process commands throw when pkg app try to call itself ([#90](https://github.com/yao-pkg/pkg/issues/90)) ([e88d159](`e88d15919f`)) ### [`v5.14.1`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5141-2024-09-17) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.14.0...v5.14.1) ##### Bug Fixes - bump pkg-fetch@3.5.12 with missing node22 macOS arm64 support ([4eea80c](`4eea80c26d`)) ### [`v5.14.0`](https://github.com/yao-pkg/pkg/blob/HEAD/CHANGELOG.md#5140-2024-09-10) [Compare Source](https://github.com/yao-pkg/pkg/compare/v5.13.0...v5.14.0) ##### Features - bump pkg-fetch@3.5.11 with nodejs 22 support (by [@faulpeltz](https://github.com/faulpeltz)) ([1d8df70](`1d8df70e21`)) </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:eyJjcmVhdGVkSW5WZXIiOiIzOC44MC4wIiwidXBkYXRlZEluVmVyIjoiMzguODAuMCIsInRhcmdldEJyYW5jaCI6ImRldmVsb3AiLCJsYWJlbHMiOlsidHlwZS9kZXBlbmRlbmNpZXMiXX0=--> Reviewed-on: #232 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>		2024-10-21 17:33:31 +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	Update jest dependencies to their latest versions (#228 )	2024-10-19 20:32:48 +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.16.0 (#232 )	2024-10-21 17:33:31 +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