No description
Ethan Lane
a09beba4e4
All checks were successful
continuous-integration/drone/push Build is passing
# 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.
- Removed ts-node
- Since we can execute the code via unit tests and the command line now, it doesn't make to have this anymore as we can test using a proper CLI
- This also fixes the issue we have with ts-node, with it not working on the latest node version
#75, #119
## 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.
- This has been tested by running `yarn start`, and it now runs the cli interface
# 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
- [ ] 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/122
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