RabbitLabs/random-bunny
4
0
Fork 0
Code Issues 10 Pull requests 8 Actions Projects 1 Releases 18 Wiki Activity
224 commits 11 branches 20 tags 29 MiB
TypeScript 95.8%
JavaScript 4.2%
Find a file
RenovateBot 82510e53a0
All checks were successful
Stage / build (push) Successful in 8s
Details
Stage / rsync (push) Successful in 6s
Details
Update dependency ts-jest to v29.2.5 (#211) 
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [ts-jest](https://kulshekhar.github.io/ts-jest) ([source](https://github.com/kulshekhar/ts-jest)) | devDependencies | patch | [`29.2.3` -> `29.2.5`](https://renovatebot.com/diffs/npm/ts-jest/29.2.3/29.2.5) |

---

### Release Notes

<details>
<summary>kulshekhar/ts-jest (ts-jest)</summary>

### [`v29.2.5`](https://github.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2925-2024-08-23)

[Compare Source](https://github.com/kulshekhar/ts-jest/compare/v29.2.4...v29.2.5)

### [`v29.2.4`](https://github.com/kulshekhar/ts-jest/blob/HEAD/CHANGELOG.md#2924-2024-08-01)

[Compare Source](https://github.com/kulshekhar/ts-jest/compare/v29.2.3...v29.2.4)

</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: #211
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:54:19 +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 ts-jest to v29.2.5 (#211) 2024-09-10 19:54:19 +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

Links

License

MIT © Vylpes