si-funciona 2.6.0 → 2.6.2

package/README.md

@@ -249,6 +249,7 @@ Simplify working with object by providing array-like parsing. Also, provides clo
         * [.mapObject(obj, fn, [thisArg])](#module_objectHelpers.mapObject) ⇒ <code>Object</code> \| <code>Array</code>
         * [.isObject(object)](#module_objectHelpers.isObject) ⇒ <code>boolean</code>
         * [.isInstanceObject(object)](#module_objectHelpers.isInstanceObject) ⇒ <code>boolean</code>
+        * [.isEqual(first, second)](#module_objectHelpers.isEqual) ⇒ <code>boolean</code>
         * [.isCloneable(value)](#module_objectHelpers.isCloneable) ⇒ <code>boolean</code>
         * [.filterObject(obj, fn, [thisArg])](#module_objectHelpers.filterObject) ⇒ <code>Object</code> \| <code>Array</code>
         * [.emptyObject(item)](#module_objectHelpers.emptyObject) ⇒ <code>boolean</code>
@@ -409,6 +410,26 @@ Check if the current object has inherited properties.
 | --- | --- |
 | object | <code>Object</code> \| <code>Array</code> | 
 
+<a name="module_objectHelpers.isEqual"></a>
+
+### objectHelpers.isEqual(first, second) ⇒ <code>boolean</code>
+Check whether two values are equal by value, however they are stored: two separately made arrays or objects with the
+same contents are equal, while two references only need to be the same when the value is a function.
+- Primitives are equal when they are the same value (and NaN equals NaN)
+- Arrays are equal when they have the same elements in the same order
+- Objects are equal when they have the same prototype (the same kind of object) and the same own properties with
+equal values, the order of the properties does not matter
+- Dates, regular expressions, Maps and Sets are compared by what they hold
+- Circular references are handled: a pair of objects which is already being compared is taken to be equal
+
+**Kind**: static method of [<code>objectHelpers</code>](#module_objectHelpers)  
+**Returns**: <code>boolean</code> - True when the values are equal.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| first | <code>\*</code> | The first value. |
+| second | <code>\*</code> | The second value. |
+
 <a name="module_objectHelpers.isCloneable"></a>
 
 ### objectHelpers.isCloneable(value) ⇒ <code>boolean</code>
@@ -577,31 +598,40 @@ Reduce several numbers to their simplest form / ratio
 <a name="module_numberHelpers.randomNumber"></a>
 
 ### numberHelpers.randomNumber(range, [offset], [interval]) ⇒ <code>number</code>
-Create a single random number within provided range. And with optional offset,
-The distance between the result numbers can be adjusted with interval.
+Create a single random number from offset up to (but never including) offset + range. With optional offset,
+the distance between the result numbers can be adjusted with interval. Matches randomInteger, which gives the
+whole numbers of the same span.
 
 **Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| range | <code>number</code> |  | Choose the breadth of the random number (0-100 would be 100 for range) |
-| [offset] | <code>number</code> | <code>0</code> | Choose the starting number (1-10 would be 1 for offset, 9 for range) |
-| [interval] | <code>number</code> | <code>1</code> | Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for offset, 2 for range) |
+| range | <code>number</code> |  | Choose the breadth of the random number (0 up to, but not including, 100 would be 100 for range) |
+| [offset] | <code>number</code> | <code>0</code> | Choose the starting number (1 up to, but not including, 10 would be 1 for offset, 9 for range) |
+| [interval] | <code>number</code> | <code>1</code> | Choose the multiplier applied to the result (~5, ~10, ~15 would be 5 for interval, 1 for offset, 2 for range) |
 
 <a name="module_numberHelpers.randomInteger"></a>
 
 ### numberHelpers.randomInteger(range, [offset], [interval]) ⇒ <code>number</code>
-Create a single random integer within provide range. And with optional offset,
-The distance between the result numbers can be adjusted with interval.
+Create a single random integer from a set of `range` possible values, starting at the optional offset.
+With no offset the result is 0 to range - 1 (so range is the number of possible values, the same as an array length
+when choosing an index). The distance between the result numbers can be adjusted with interval.
 
 **Kind**: static method of [<code>numberHelpers</code>](#module_numberHelpers)  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| range | <code>number</code> |  | Choose the breadth of the random number (0-100 would be 100 for range) |
-| [offset] | <code>number</code> | <code>0</code> | Choose the starting number (1-10 would be 1 for offset, 9 for range) |
-| [interval] | <code>number</code> | <code>1</code> | Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for offset, 2 for range) |
+| range | <code>number</code> |  | The number of possible values (0-99 would be 100 for range) |
+| [offset] | <code>number</code> | <code>0</code> | Choose the starting number (1-10 would be 1 for offset, 10 for range) |
+| [interval] | <code>number</code> | <code>1</code> | Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for offset, 3 for range) |
 
+**Example**  
+```js
+randomInteger(1) // always 0 (one possible value)
+randomInteger(2) // 0 or 1
+randomInteger(3, 1, 5) // 5, 10 or 15
+items[randomInteger(items.length)] // a random valid index
+```
 <a name="module_numberHelpers.lowestCommonDenominator"></a>
 
 ### numberHelpers.lowestCommonDenominator(...numbers) ⇒ <code>number</code>