No description
28cbfe5f46
* Resolve "Pass Entire JSON String to the user" * Add a promise function * Adjust documentation * Fix ci issues * Fix ci issues 2 Co-authored-by: Ethan Lane <ethan.lane@influentialsoftware.com> Co-authored-by: Ethan Lane <ethan.lane@influentialsoftware.com> |
||
---|---|---|
.gitlab | ||
.eslintrc | ||
.gitignore | ||
.gitlab-ci.yml | ||
.npmignore | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
index.js | ||
LICENSE | ||
license | ||
package-lock.json | ||
package.json | ||
readme.md |
random-bunny
Get a random image url from a subreddit of your choosing.
Install
$ npm install --save random-bunny
Usage
const { randomBunny } = require('random-bunny');
randomBunny('rabbits', 'new', res => {
console.log(res.title + ": " + res.url);
});
const { promise } = require('random-bunny');
promise('rabbits', 'new').then((res) => {
console.log(res.title);
});
API
randomBunny()
Returns a json string
for a random post to the callback
. Accepts 3 arguments: subreddit
, sortby
('new', 'hot', 'top'), callback(res)
The json string which gets returned consists of:
- archived
- downs
- hidden
- permalink
- subreddit
- subredditSubscribers
- title
- ups
- url
promise()
Returns a json string
for a random post in a promise
. Accepts 2 arguments: subreddit
, sortby
('new', 'hot', 'top').
The json string returned in the promise consists of the same above.
Notes
- Node 4 or newer.
- based upon Random Puppy
Links
- Discord: Server Link
License
MIT © Vylpes