RabbitLabs/random-bunny
5
0
Fork 0
Code Issues 9 Pull requests 11 Projects 1 Releases 18 Wiki Activity Actions
No description
147 commits 15 branches 20 tags 35 MiB
TypeScript 95.8%
JavaScript 4.2%
Find a file
Renovate Bot a9a756a001
All checks were successful
continuous-integration/drone/push Build is passing
Details
Update dependency got to v14 (#134) 
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [got](https://github.com/sindresorhus/got) | resolutions | major | [`^13.0.0` -> `^14.0.0`](https://renovatebot.com/diffs/npm/got/13.0.0/14.0.0) |

---

### Release Notes

<details>
<summary>sindresorhus/got (got)</summary>

### [`v14.0.0`](https://github.com/sindresorhus/got/releases/tag/v14.0.0)

[Compare Source](https://github.com/sindresorhus/got/compare/v13.0.0...v14.0.0)

##### Breaking

-   Require Node.js 20 ([#&#8203;2313](https://github.com/sindresorhus/got/issues/2313))  [`a004263`](https://github.com/sindresorhus/got/commit/a004263)
    -   Why not target the oldest active Node.js LTS, which is Node.js 18? I usually strictly follow this convention in my packages. However, this package is the exception because the HTTP part of Node.js is consistently buggy, and I don't have time to work around issues in older Node.js releases. I you need to still support Node.js 18, I suggest staying on Got v13, which is quite stable. Node.js 18 will be out of active LTS in 5 months.

##### Improvements

-   Make `followRedirect` option accept a function ([#&#8203;2306](https://github.com/sindresorhus/got/issues/2306))  [`7c3f147`](https://github.com/sindresorhus/got/commit/7c3f147)

</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/134
Co-authored-by: Renovate Bot <renovate@vylpes.com>
Co-committed-by: Renovate Bot <renovate@vylpes.com>
2024-01-16 19:14:22 +00: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
src Add higher limit on json (#139) 2024-01-12 17:48:37 +00:00
tests Add higher limit on json (#139) 2024-01-12 17:48:37 +00:00
.drone.yml Add push event to .drone.yml 2023-04-29 14:43:47 +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 error codes and error messages to failed results (#89) 2023-09-15 15:18:57 +01:00
.gitlab-ci.yml Add aslant to gitlab project ci 2021-01-13 21:08:47 +00:00
.npmignore Setup Jest (#57) 2023-04-22 13:20:30 +01: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 Update dependency got to v14 (#134) 2024-01-16 19:14:22 +00:00
readme.md Updatr documentation to remove maxTries variable 2023-02-22 18:19:47 +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 got to v14 (#134) 2024-01-16 19:14:22 +00: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

Notes

Links

License

MIT © Vylpes