No description

Find a file

Ethan Lane 5ea8b72e54 All checks were successful continuous-integration/drone/push Build is passing Details Add higher limit on json (#139 ) # Description Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - Add higher limit on the json result - This will fix the tests not always fetching an image from r/rabbits, as not every post in the top is a single image #125 ## Type of change Please delete options that are not relevant. - [x] Bug fix (non-breaking change which fixes an issue) # How Has This Been Tested? Please describe the tests that you ran to verify the changes. Provide instructions so we can reproduce. Please also list any relevant details to your test configuration. # Checklist - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that provde my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/139 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com>		2024-01-12 17:48:37 +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	Fix not being able to execute the code via ts-node (#122 )	2023-12-08 17:07:51 +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	Fix not being able to execute the code via ts-node (#122 )	2023-12-08 17:07:51 +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

Node 4 or newer.
based upon Random Puppy