From be967d4d01446d30fe0c5285cd0c38c055dd2ca9 Mon Sep 17 00:00:00 2001 From: glhrmv Date: Sat, 23 Sep 2017 16:19:58 +0100 Subject: [PATCH] Update readme to document inRange method --- readme.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/readme.md b/readme.md index ee1761d..d615e5e 100644 --- a/readme.md +++ b/readme.md @@ -117,6 +117,11 @@ An object is plain if it's created by either `{}`, `new Object()`, or `Object.cr ##### .iterable(value) ##### .typedArray(value) +##### .inRange(value, range) + +Check to see if the value is within a given range, for example `is.inRange(3, [0, 5])`. +The range supplied can be an array of any size, though this will only check for +the minimum and maximum values in it. ## FAQ