No description
Ethan Lane
beba61e4e2
Some checks failed
continuous-integration/drone/push Build is failing
# 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 sort option (`--sort`) to allow you to configure the sort by field
- Add query metadata option (`--query-metadata`, `-q`) to return the queried inputs
- This helps with testing to ensure that the inputs are properly accepted
#74
## 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.
- Have tested manually and have added unit tests too
- I have added an option to include the query metadata to help with seeing if it worked
# Checklist
- [x] My code follows the style guidelines of this project
- [x] 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
- [x] My changes generate no new warnings
- [x] I have added tests that provde my fix is effective or that my feature works
- [x] 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/123
Reviewed-by: VylpesTester <tester@vylpes.com>
Co-authored-by: Ethan Lane <ethan@vylpes.com>
Co-committed-by: Ethan Lane <ethan@vylpes.com>
|
||
|---|---|---|
| .gitea | ||
| .github | ||
| .gitlab | ||
| src | ||
| tests | ||
| .drone.yml | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .npmignore | ||
| 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
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
Links
- Discord: Server Link
- Support: helpdesk@vylpes.com
License
MIT © Vylpes