random-bunny/readme.md

65 lines
1.1 KiB
Markdown
Raw Normal View History

2020-12-20 19:39:03 +00:00
# random-bunny
2016-04-27 20:06:24 +01:00
2020-12-20 19:39:03 +00:00
> Get a random image url from a subreddit of your choosing.
2016-04-27 20:06:24 +01:00
## Install
2021-12-01 20:53:53 +00:00
```bash
npm install --save random-bunny
2016-04-27 20:06:24 +01:00
```
2021-12-01 20:53:53 +00:00
or if you're using yarn
2016-04-27 20:06:24 +01:00
2021-12-01 20:53:53 +00:00
```bash
yarn add random-bunny
```
2016-04-27 20:06:24 +01:00
2021-12-01 20:53:53 +00:00
## Usage
2016-04-27 20:06:24 +01:00
2021-12-01 20:53:53 +00:00
```ts
import randomBunny from "random-bunny";
2021-12-01 20:53:53 +00:00
// ... In an async function
const result = await randomBunny('rabbits', 'hot');
2021-12-01 20:53:53 +00:00
console.log(result);
```
2016-04-27 20:06:24 +01:00
## API
2020-12-20 19:39:03 +00:00
### `randomBunny()`
2016-04-27 20:06:24 +01:00
Returns a `json string` for a random post. Accepts 2 arguments: `subreddit`, and `sortby` ('new', 'hot', 'top')
2021-03-01 18:15:51 +00:00
The json string which gets returned consists of:
- archived
- downs
- hidden
- permalink
- subreddit
- subredditSubscribers
- title
- ups
- url
2016-04-29 03:23:21 +01:00
2021-12-01 20:53:53 +00:00
`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.
2016-04-27 20:12:06 +01:00
## Notes
* Node 4 or newer.
2020-12-20 19:39:03 +00:00
* based upon [Random Puppy](https://github.com/dylang/random-puppy)
## Links
* Discord: [Server Link](https://go.vylpes.xyz/A6HcA)
* Support: [helpdesk@vylpes.com](mailto:helpdesk@vylpes.com)
2016-04-27 20:06:24 +01:00
## License
2021-12-01 20:53:53 +00:00
MIT © [Vylpes](https://www.vylpes.com)