Ethan Lane
eda1fd31c4
All checks were successful
Test / build (push) Successful in 8s
# 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 the forgejo workflows to the repo - The secret `NPM_TOKEN` has been added organisation wide #172 ## Type of change Please delete options that are not relevant. - [x] New feature (non-breaking change which adds functionality) # 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://git.vylpes.xyz/RabbitLabs/random-bunny/pulls/184 Reviewed-by: VylpesTester <tester@vylpes.com> Co-authored-by: Ethan Lane <ethan@vylpes.com> Co-committed-by: Ethan Lane <ethan@vylpes.com> |
||
|---|---|---|
| .forgejo/workflows | ||
| .gitea | ||
| .github | ||
| .gitlab | ||
| docs | ||
| src | ||
| tests | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .npmignore | ||
| .woodpecker.yml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| jest.config.cjs | ||
| jest.setup.js | ||
| LICENSE | ||
| package.json | ||
| readme.md | ||
| renovate.json | ||
| tsconfig.json | ||
| yarn.lock | ||
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 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
Links
- Discord: Server Link
- Support: helpdesk@vylpes.com
License
MIT © Vylpes