No description
Ethan Lane
e18610042e
- Update jest dependencies to their latest versions - Remove the package dependency resolutions which no longer cause vulnerabilities #199 Reviewed-on: #228 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 | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .npmignore | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| eslint.config.mjs | ||
| 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 3 arguments: subreddit, sortby ('new', 'hot', 'top'), and limit (1-100, default 100)
The json string which gets returned consists of:
- archived
- author
- 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