No description

Find a file

Renovate Bot bc04f9d20d All checks were successful Stage / build (push) Successful in 9s Details Stage / rsync (push) Successful in 5s Details Update dependency typescript to v5.6.3 (#236 ) This PR contains the following updates: \| Package \| Type \| Update \| Change \| \|---\|---\|---\|---\| \| [typescript](https://www.typescriptlang.org/) ([source](https://github.com/microsoft/TypeScript)) \| devDependencies \| minor \| [`5.5.4` -> `5.6.3`](https://renovatebot.com/diffs/npm/typescript/5.5.4/5.6.3) \| --- ### Release Notes <details> <summary>microsoft/TypeScript (typescript)</summary> ### [`v5.6.3`](https://github.com/microsoft/TypeScript/releases/tag/v5.6.3): TypeScript 5.6.3 [Compare Source](https://github.com/microsoft/TypeScript/compare/v5.6.2...v5.6.3) For release notes, check out the [release announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-6/). For the complete list of fixed issues, check out the - [fixed issues query for Typescript 5.6.0 (Beta)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.0%22+is%3Aclosed+). - [fixed issues query for Typescript 5.6.1 (RC)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.1%22+is%3Aclosed+). - [fixed issues query for Typescript 5.6.2 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.2%22+is%3Aclosed+). - [fixed issues query for Typescript 5.6.3 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.3%22+is%3Aclosed+). Downloads are available on: - [npm](https://www.npmjs.com/package/typescript) - [NuGet package](https://www.nuget.org/packages/Microsoft.TypeScript.MSBuild) ### [`v5.6.2`](https://github.com/microsoft/TypeScript/releases/tag/v5.6.2): TypeScript 5.6 [Compare Source](https://github.com/microsoft/TypeScript/compare/v5.5.4...v5.6.2) For release notes, check out the [release announcement](https://devblogs.microsoft.com/typescript/announcing-typescript-5-6/). For the complete list of fixed issues, check out the - [fixed issues query for Typescript 5.6.0 (Beta)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.0%22+is%3Aclosed+). - [fixed issues query for Typescript 5.6.1 (RC)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.1%22+is%3Aclosed+). - [fixed issues query for Typescript 5.6.2 (Stable)](https://github.com/Microsoft/TypeScript/issues?utf8=%E2%9C%93\&q=milestone%3A%22TypeScript+5.6.2%22+is%3Aclosed+). Downloads are available on: - [npm](https://www.npmjs.com/package/typescript) - [NuGet package](https://www.nuget.org/packages/Microsoft.TypeScript.MSBuild) </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: #236 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>		2024-10-15 17:51:32 +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 dependency @typescript-eslint/parser to v8 (#222 )	2024-10-15 17:47:49 +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 typescript to v5.6.3 (#236 )	2024-10-15 17:51:32 +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