Find a file

Ethan Lane 6c1d0dfe09 All checks were successful ci/woodpecker/manual/woodpecker Pipeline was successful Details Add binary building (#151 ) # 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. - Install pkg - Create ability to build package - Add to woodpecker-ci #101 ## Type of change Please delete options that are not relevant. - [x] New feature (non-breaking change which adds functionality) - [x] This change requires a documentation update # 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/151 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com>		2024-03-01 19:51:12 +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
docs	Add documentation on the cli (#149 )	2024-02-23 18:30:56 +00:00
src	Add ability to output the CLI in JSON format (#124 )	2024-01-19 18:02:16 +00:00
tests	Add ability to output the CLI in JSON format (#124 )	2024-01-19 18:02:16 +00: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 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
.woodpecker.yml	Add binary building (#151 )	2024-03-01 19:51:12 +00: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	Add binary building (#151 )	2024-03-01 19:51:12 +00:00
readme.md	Add documentation on the cli (#149 )	2024-02-23 18:30:56 +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	Add binary building (#151 )	2024-03-01 19:51:12 +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

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