From 948f513b53f8bc7afc55a2ae135d5b9e405158f4 Mon Sep 17 00:00:00 2001 From: Ethan Lane Date: Wed, 22 Feb 2023 18:19:47 +0000 Subject: [PATCH] Updatr documentation to remove maxTries variable --- readme.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index d129cf3..4403cd6 100644 --- a/readme.md +++ b/readme.md @@ -21,7 +21,7 @@ yarn add random-bunny import randomBunny from "random-bunny"; // ... In an async function -const result = await randomBunny('rabbits', 'hot', 100); +const result = await randomBunny('rabbits', 'hot'); console.log(result); ``` @@ -29,7 +29,7 @@ console.log(result); ### `randomBunny()` -Returns a `json string` for a random post. Accepts 3 arguments: `subreddit`, `sortby` ('new', 'hot', 'top'), `maxTries?` (default 100) +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 @@ -44,8 +44,6 @@ The json string which gets returned consists of: `sortBy` will default to 'hot' if not given or invalid -`maxTries` prevents the script from rerolling too many times. The script rerolls the randomiser if the post its given doesn't contain an image. Default 100. - ## Notes * Node 4 or newer.