-# <a href="https://lodash.com/">lodash</a> <span>v4.5.1</span>
+# <a href="https://lodash.com/">lodash</a> <span>v4.11.2</span>
<!-- div class="toc-container" -->
<!-- div -->
## `Array`
-* <a href="#_chunkarray-size0">`_.chunk`</a>
+* <a href="#_chunkarray-size1">`_.chunk`</a>
* <a href="#_compactarray">`_.compact`</a>
* <a href="#_concatarray-values">`_.concat`</a>
* <a href="#_differencearray-values">`_.difference`</a>
* <a href="#_joinarray-separator-">`_.join`</a>
* <a href="#_lastarray">`_.last`</a>
* <a href="#_lastindexofarray-value-fromindexarraylength-1">`_.lastIndexOf`</a>
+* <a href="#_ntharray-n0">`_.nth`</a>
* <a href="#_pullarray-values">`_.pull`</a>
* <a href="#_pullallarray-values">`_.pullAll`</a>
* <a href="#_pullallbyarray-values-iteratee_identity">`_.pullAllBy`</a>
+* <a href="#_pullallwitharray-values-comparator">`_.pullAllWith`</a>
* <a href="#_pullatarray-indexes">`_.pullAt`</a>
* <a href="#_removearray-predicate_identity">`_.remove`</a>
-* <a href="#_reverse">`_.reverse`</a>
+* <a href="#_reversearray">`_.reverse`</a>
* <a href="#_slicearray-start0-endarraylength">`_.slice`</a>
* <a href="#_sortedindexarray-value">`_.sortedIndex`</a>
* <a href="#_sortedindexbyarray-value-iteratee_identity">`_.sortedIndexBy`</a>
* <a href="#_findcollection-predicate_identity">`_.find`</a>
* <a href="#_findlastcollection-predicate_identity">`_.findLast`</a>
* <a href="#_flatmapcollection-iteratee_identity">`_.flatMap`</a>
+* <a href="#_flatmapdeepcollection-iteratee_identity">`_.flatMapDeep`</a>
+* <a href="#_flatmapdepthcollection-iteratee_identity-depth1">`_.flatMapDepth`</a>
* <a href="#_foreachcollection-iteratee_identity">`_.forEach`</a>
* <a href="#_foreachrightcollection-iteratee_identity">`_.forEachRight`</a>
* <a href="#_groupbycollection-iteratee_identity">`_.groupBy`</a>
* <a href="#_invokemapcollection-path-args">`_.invokeMap`</a>
* <a href="#_keybycollection-iteratee_identity">`_.keyBy`</a>
* <a href="#_mapcollection-iteratee_identity">`_.map`</a>
-* <a href="#_orderbycollection-iteratees-_identity-orders">`_.orderBy`</a>
+* <a href="#_orderbycollection-iteratees_identity-orders">`_.orderBy`</a>
* <a href="#_partitioncollection-predicate_identity">`_.partition`</a>
* <a href="#_reducecollection-iteratee_identity-accumulator">`_.reduce`</a>
* <a href="#_reducerightcollection-iteratee_identity-accumulator">`_.reduceRight`</a>
* <a href="#_rejectcollection-predicate_identity">`_.reject`</a>
* <a href="#_samplecollection">`_.sample`</a>
-* <a href="#_samplesizecollection-n0">`_.sampleSize`</a>
+* <a href="#_samplesizecollection-n1">`_.sampleSize`</a>
* <a href="#_shufflecollection">`_.shuffle`</a>
* <a href="#_sizecollection">`_.size`</a>
* <a href="#_somecollection-predicate_identity">`_.some`</a>
-* <a href="#_sortbycollection-iteratees-_identity">`_.sortBy`</a>
+* <a href="#_sortbycollection-iteratees_identity">`_.sortBy`</a>
<!-- /div -->
* <a href="#_bindkeyobject-key-partials">`_.bindKey`</a>
* <a href="#_curryfunc-arityfunclength">`_.curry`</a>
* <a href="#_curryrightfunc-arityfunclength">`_.curryRight`</a>
-* <a href="#_debouncefunc-wait0-options">`_.debounce`</a>
+* <a href="#_debouncefunc-wait0-options-optionsleadingfalse-optionsmaxwait-optionstrailingtrue">`_.debounce`</a>
* <a href="#_deferfunc-args">`_.defer`</a>
* <a href="#_delayfunc-wait-args">`_.delay`</a>
* <a href="#_flipfunc">`_.flip`</a>
* <a href="#_memoizefunc-resolver">`_.memoize`</a>
* <a href="#_negatepredicate">`_.negate`</a>
* <a href="#_oncefunc">`_.once`</a>
-* <a href="#_overargsfunc-transforms">`_.overArgs`</a>
+* <a href="#_overargsfunc">`_.overArgs`</a>
* <a href="#_partialfunc-partials">`_.partial`</a>
* <a href="#_partialrightfunc-partials">`_.partialRight`</a>
* <a href="#_reargfunc-indexes">`_.rearg`</a>
* <a href="#_restfunc-startfunclength-1">`_.rest`</a>
* <a href="#_spreadfunc-start0">`_.spread`</a>
-* <a href="#_throttlefunc-wait0-options">`_.throttle`</a>
+* <a href="#_throttlefunc-wait0-options-optionsleadingtrue-optionstrailingtrue">`_.throttle`</a>
* <a href="#_unaryfunc">`_.unary`</a>
* <a href="#_wrapvalue-wrapperidentity">`_.wrap`</a>
## `Math`
* <a href="#_addaugend-addend">`_.add`</a>
* <a href="#_ceilnumber-precision0">`_.ceil`</a>
+* <a href="#_dividedividend-divisor">`_.divide`</a>
* <a href="#_floornumber-precision0">`_.floor`</a>
* <a href="#_maxarray">`_.max`</a>
* <a href="#_maxbyarray-iteratee_identity">`_.maxBy`</a>
* <a href="#_meanarray">`_.mean`</a>
+* <a href="#_meanbyarray-iteratee_identity">`_.meanBy`</a>
* <a href="#_minarray">`_.min`</a>
* <a href="#_minbyarray-iteratee_identity">`_.minBy`</a>
+* <a href="#_multiplymultiplier-multiplicand">`_.multiply`</a>
* <a href="#_roundnumber-precision0">`_.round`</a>
* <a href="#_subtractminuend-subtrahend">`_.subtract`</a>
* <a href="#_sumarray">`_.sum`</a>
* <a href="#_createprototype-properties">`_.create`</a>
* <a href="#_defaultsobject-sources">`_.defaults`</a>
* <a href="#_defaultsdeepobject-sources">`_.defaultsDeep`</a>
+* <a href="#_topairsobject" class="alias">`_.entries` -> `toPairs`</a>
+* <a href="#_topairsinobject" class="alias">`_.entriesIn` -> `toPairsIn`</a>
* <a href="#_assigninobject-sources" class="alias">`_.extend` -> `assignIn`</a>
* <a href="#_assigninwithobject-sources-customizer" class="alias">`_.extendWith` -> `assignInWith`</a>
* <a href="#_findkeyobject-predicate_identity">`_.findKey`</a>
* <a href="#_topairsinobject">`_.toPairsIn`</a>
* <a href="#_transformobject-iteratee_identity-accumulator">`_.transform`</a>
* <a href="#_unsetobject-path">`_.unset`</a>
+* <a href="#_updateobject-path-updater">`_.update`</a>
+* <a href="#_updatewithobject-path-updater-customizer">`_.updateWith`</a>
* <a href="#_valuesobject">`_.values`</a>
* <a href="#_valuesinobject">`_.valuesIn`</a>
* <a href="#_prototypeatpaths">`_.prototype.at`</a>
* <a href="#_prototypechain">`_.prototype.chain`</a>
* <a href="#_prototypecommit">`_.prototype.commit`</a>
-* <a href="#_prototypeflatmapiteratee_identity">`_.prototype.flatMap`</a>
* <a href="#_prototypenext">`_.prototype.next`</a>
* <a href="#_prototypeplantvalue">`_.prototype.plant`</a>
* <a href="#_prototypereverse">`_.prototype.reverse`</a>
* <a href="#_padendstring-length0-chars">`_.padEnd`</a>
* <a href="#_padstartstring-length0-chars">`_.padStart`</a>
* <a href="#_parseintstring-radix10">`_.parseInt`</a>
-* <a href="#_repeatstring-n0">`_.repeat`</a>
+* <a href="#_repeatstring-n1">`_.repeat`</a>
* <a href="#_replacestring-pattern-replacement">`_.replace`</a>
* <a href="#_snakecasestring">`_.snakeCase`</a>
* <a href="#_splitstring-separator-limit">`_.split`</a>
* <a href="#_startcasestring">`_.startCase`</a>
* <a href="#_startswithstring-target-position0">`_.startsWith`</a>
-* <a href="#_templatestring-options">`_.template`</a>
+* <a href="#_templatestring-options-optionsescape_templatesettingsescape-optionsevaluate_templatesettingsevaluate-optionsimports_templatesettingsimports-optionsinterpolate_templatesettingsinterpolate-optionssourceurllodashtemplatesourcesn-optionsvariableobj">`_.template`</a>
* <a href="#_tolowerstring">`_.toLower`</a>
* <a href="#_toupperstring">`_.toUpper`</a>
* <a href="#_trimstring-charswhitespace">`_.trim`</a>
<!-- div -->
## `Util`
-* <a href="#_attemptfunc">`_.attempt`</a>
+* <a href="#_attemptfunc-args">`_.attempt`</a>
* <a href="#_bindallobject-methodnames">`_.bindAll`</a>
* <a href="#_condpairs">`_.cond`</a>
* <a href="#_conformssource">`_.conforms`</a>
* <a href="#_matchespropertypath-srcvalue">`_.matchesProperty`</a>
* <a href="#_methodpath-args">`_.method`</a>
* <a href="#_methodofobject-args">`_.methodOf`</a>
-* <a href="#_mixinobjectlodash-source-options">`_.mixin`</a>
+* <a href="#_mixinobjectlodash-source-options-optionschaintrue">`_.mixin`</a>
* <a href="#_noconflict">`_.noConflict`</a>
* <a href="#_noop">`_.noop`</a>
* <a href="#_nthargn0">`_.nthArg`</a>
-* <a href="#_overiteratees">`_.over`</a>
-* <a href="#_overeverypredicates">`_.overEvery`</a>
-* <a href="#_oversomepredicates">`_.overSome`</a>
+* <a href="#_overiteratees_identity">`_.over`</a>
+* <a href="#_overeverypredicates_identity">`_.overEvery`</a>
+* <a href="#_oversomepredicates_identity">`_.overSome`</a>
* <a href="#_propertypath">`_.property`</a>
* <a href="#_propertyofobject">`_.propertyOf`</a>
* <a href="#_rangestart0-end-step1">`_.range`</a>
* <a href="#_templatesettingsescape">`_.templateSettings.escape`</a>
* <a href="#_templatesettingsevaluate">`_.templateSettings.evaluate`</a>
* <a href="#_templatesettingsimports">`_.templateSettings.imports`</a>
-* <a href="#_templatesettingsimports_">`_.templateSettings.imports._`</a>
* <a href="#_templatesettingsinterpolate">`_.templateSettings.interpolate`</a>
* <a href="#_templatesettingsvariable">`_.templateSettings.variable`</a>
<!-- /div -->
+<!-- div -->
+
+## `Methods`
+* <a href="#_templatesettingsimports_">`_.templateSettings.imports._`</a>
+
+<!-- /div -->
+
<!-- /div -->
<!-- div class="doc-container" -->
<!-- div -->
-### <a id="_chunkarray-size0"></a>`_.chunk(array, [size=0])`
-<a href="#_chunkarray-size0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5480 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.chunk "See the npm package")
+### <a id="_chunkarray-size1"></a>`_.chunk(array, [size=1])`
+<a href="#_chunkarray-size1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L5982 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.chunk "See the npm package")
Creates an array of elements split into groups the length of `size`.
If `array` can't be split evenly, the final chunk will be the remaining
elements.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to process.
-2. `[size=0]` *(number)*: The length of each chunk.
+2. `[size=1]` *(number)*: The length of each chunk
#### Returns
-*(Array)*: Returns the new array containing chunks.
+*(Array)*: Returns the new array containing chunks.
#### Example
```js
<!-- div -->
### <a id="_compactarray"></a>`_.compact(array)`
-<a href="#_compactarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5511 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.compact "See the npm package")
+<a href="#_compactarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6017 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.compact "See the npm package")
Creates an array with all falsey values removed. The values `false`, `null`,
`0`, `""`, `undefined`, and `NaN` are falsey.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to compact.
#### Returns
-*(Array)*: Returns the new array of filtered values.
+*(Array)*: Returns the new array of filtered values.
#### Example
```js
<!-- div -->
### <a id="_concatarray-values"></a>`_.concat(array, [values])`
-<a href="#_concatarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5547 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.concat "See the npm package")
+<a href="#_concatarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6054 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.concat "See the npm package")
Creates a new array concatenating `array` with any additional arrays
and/or values.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to concatenate.
2. `[values]` *(...*)*: The values to concatenate.
#### Returns
-*(Array)*: Returns the new concatenated array.
+*(Array)*: Returns the new concatenated array.
#### Example
```js
<!-- div -->
### <a id="_differencearray-values"></a>`_.difference(array, [values])`
-<a href="#_differencearray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5571 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.difference "See the npm package")
+<a href="#_differencearray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6087 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.difference "See the npm package")
-Creates an array of unique `array` values not included in the other
-given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
-for equality comparisons.
+Creates an array of unique `array` values not included in the other given
+arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
+for equality comparisons. The order of result values is determined by the
+order they occur in the first array.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
2. `[values]` *(...Array)*: The values to exclude.
#### Returns
-*(Array)*: Returns the new array of filtered values.
+*(Array)*: Returns the new array of filtered values.
#### Example
```js
<!-- div -->
### <a id="_differencebyarray-values-iteratee_identity"></a>`_.differenceBy(array, [values], [iteratee=_.identity])`
-<a href="#_differencebyarray-values-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5598 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.differenceby "See the npm package")
+<a href="#_differencebyarray-values-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6117 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.differenceby "See the npm package")
This method is like `_.difference` except that it accepts `iteratee` which
is invoked for each element of `array` and `values` to generate the criterion
-by which uniqueness is computed. The iteratee is invoked with one argument: (value).
+by which they're compared. Result values are chosen from the first array.
+The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
2. `[values]` *(...Array)*: The values to exclude.
-3. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+3. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns the new array of filtered values.
+*(Array)*: Returns the new array of filtered values.
#### Example
```js
<!-- div -->
### <a id="_differencewitharray-values-comparator"></a>`_.differenceWith(array, [values], [comparator])`
-<a href="#_differencewitharray-values-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5627 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.differencewith "See the npm package")
+<a href="#_differencewitharray-values-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6148 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.differencewith "See the npm package")
This method is like `_.difference` except that it accepts `comparator`
-which is invoked to compare elements of `array` to `values`. The comparator
-is invoked with two arguments: (arrVal, othVal).
+which is invoked to compare elements of `array` to `values`. Result values
+are chosen from the first array. The comparator is invoked with two arguments:<br>
+*(arrVal, othVal)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
2. `[values]` *(...Array)*: The values to exclude.
3. `[comparator]` *(Function)*: The comparator invoked per element.
#### Returns
-*(Array)*: Returns the new array of filtered values.
+*(Array)*: Returns the new array of filtered values.
#### Example
```js
<!-- div -->
### <a id="_droparray-n1"></a>`_.drop(array, [n=1])`
-<a href="#_droparray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5661 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.drop "See the npm package")
+<a href="#_droparray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6183 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.drop "See the npm package")
Creates a slice of `array` with `n` elements dropped from the beginning.
+#### Since
+0.5.0
#### Arguments
1. `array` *(Array)*: The array to query.
2. `[n=1]` *(number)*: The number of elements to drop.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_droprightarray-n1"></a>`_.dropRight(array, [n=1])`
-<a href="#_droprightarray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5694 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.dropright "See the npm package")
+<a href="#_droprightarray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6217 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.dropright "See the npm package")
Creates a slice of `array` with `n` elements dropped from the end.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
2. `[n=1]` *(number)*: The number of elements to drop.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_droprightwhilearray-predicate_identity"></a>`_.dropRightWhile(array, [predicate=_.identity])`
-<a href="#_droprightwhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5738 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.droprightwhile "See the npm package")
+<a href="#_droprightwhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6263 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.droprightwhile "See the npm package")
Creates a slice of `array` excluding elements dropped from the end.
Elements are dropped until `predicate` returns falsey. The predicate is
-invoked with three arguments: (value, index, array).
+invoked with three arguments: *(value, index, array)*.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_dropwhilearray-predicate_identity"></a>`_.dropWhile(array, [predicate=_.identity])`
-<a href="#_dropwhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5778 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.dropwhile "See the npm package")
+<a href="#_dropwhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6305 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.dropwhile "See the npm package")
Creates a slice of `array` excluding elements dropped from the beginning.
Elements are dropped until `predicate` returns falsey. The predicate is
-invoked with three arguments: (value, index, array).
+invoked with three arguments: *(value, index, array)*.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_fillarray-value-start0-endarraylength"></a>`_.fill(array, value, [start=0], [end=array.length])`
-<a href="#_fillarray-value-start0-endarraylength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5812 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.fill "See the npm package")
+<a href="#_fillarray-value-start0-endarraylength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6340 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.fill "See the npm package")
Fills elements of `array` with `value` from `start` up to, but not
including, `end`.
<br>
**Note:** This method mutates `array`.
+#### Since
+3.2.0
#### Arguments
1. `array` *(Array)*: The array to fill.
2. `value` *(*)*: The value to fill `array` with.
4. `[end=array.length]` *(number)*: The end position.
#### Returns
-*(Array)*: Returns `array`.
+*(Array)*: Returns `array`.
#### Example
```js
<!-- div -->
### <a id="_findindexarray-predicate_identity"></a>`_.findIndex(array, [predicate=_.identity])`
-<a href="#_findindexarray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5857 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findindex "See the npm package")
+<a href="#_findindexarray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6387 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findindex "See the npm package")
This method is like `_.find` except that it returns the index of the first
element `predicate` returns truthy for instead of the element itself.
+#### Since
+1.1.0
#### Arguments
1. `array` *(Array)*: The array to search.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(number)*: Returns the index of the found element, else `-1`.
+*(number)*: Returns the index of the found element, else `-1`.
#### Example
```js
<!-- div -->
### <a id="_findlastindexarray-predicate_identity"></a>`_.findLastIndex(array, [predicate=_.identity])`
-<a href="#_findlastindexarray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5896 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findlastindex "See the npm package")
+<a href="#_findlastindexarray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6428 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findlastindex "See the npm package")
This method is like `_.findIndex` except that it iterates over elements
of `collection` from right to left.
+#### Since
+2.0.0
#### Arguments
1. `array` *(Array)*: The array to search.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(number)*: Returns the index of the found element, else `-1`.
+*(number)*: Returns the index of the found element, else `-1`.
#### Example
```js
<!-- div -->
### <a id="_flattenarray"></a>`_.flatten(array)`
-<a href="#_flattenarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5915 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flatten "See the npm package")
+<a href="#_flattenarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6448 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flatten "See the npm package")
Flattens `array` a single level deep.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to flatten.
#### Returns
-*(Array)*: Returns the new flattened array.
+*(Array)*: Returns the new flattened array.
#### Example
```js
<!-- div -->
### <a id="_flattendeeparray"></a>`_.flattenDeep(array)`
-<a href="#_flattendeeparray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5933 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flattendeep "See the npm package")
+<a href="#_flattendeeparray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6467 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flattendeep "See the npm package")
Recursively flattens `array`.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to flatten.
#### Returns
-*(Array)*: Returns the new flattened array.
+*(Array)*: Returns the new flattened array.
#### Example
```js
<!-- div -->
### <a id="_flattendeptharray-depth1"></a>`_.flattenDepth(array, [depth=1])`
-<a href="#_flattendeptharray-depth1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5957 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flattendepth "See the npm package")
+<a href="#_flattendeptharray-depth1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6492 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flattendepth "See the npm package")
Recursively flatten `array` up to `depth` times.
+#### Since
+4.4.0
#### Arguments
1. `array` *(Array)*: The array to flatten.
2. `[depth=1]` *(number)*: The maximum recursion depth.
#### Returns
-*(Array)*: Returns the new flattened array.
+*(Array)*: Returns the new flattened array.
#### Example
```js
<!-- div -->
### <a id="_frompairspairs"></a>`_.fromPairs(pairs)`
-<a href="#_frompairspairs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L5980 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.frompairs "See the npm package")
+<a href="#_frompairspairs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6516 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.frompairs "See the npm package")
The inverse of `_.toPairs`; this method returns an object composed
from key-value `pairs`.
+#### Since
+4.0.0
#### Arguments
1. `pairs` *(Array)*: The key-value pairs.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_headarray"></a>`_.head(array)`
-<a href="#_headarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6009 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.head "See the npm package")
+<a href="#_headarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6546 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.head "See the npm package")
Gets the first element of `array`.
+#### Since
+0.1.0
#### Aliases
*_.first*
1. `array` *(Array)*: The array to query.
#### Returns
-*(*)*: Returns the first element of `array`.
+*(*)*: Returns the first element of `array`.
#### Example
```js
<!-- div -->
### <a id="_indexofarray-value-fromindex0"></a>`_.indexOf(array, value, [fromIndex=0])`
-<a href="#_indexofarray-value-fromindex0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6035 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.indexof "See the npm package")
+<a href="#_indexofarray-value-fromindex0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6573 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.indexof "See the npm package")
Gets the index at which the first occurrence of `value` is found in `array`
using [`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
-for equality comparisons. If `fromIndex` is negative, it's used as the offset
-from the end of `array`.
+for equality comparisons. If `fromIndex` is negative, it's used as the
+offset from the end of `array`.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to search.
2. `value` *(*)*: The value to search for.
3. `[fromIndex=0]` *(number)*: The index to search from.
#### Returns
-*(number)*: Returns the index of the matched value, else `-1`.
+*(number)*: Returns the index of the matched value, else `-1`.
#### Example
```js
<!-- div -->
### <a id="_initialarray"></a>`_.initial(array)`
-<a href="#_initialarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6060 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.initial "See the npm package")
+<a href="#_initialarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6599 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.initial "See the npm package")
Gets all but the last element of `array`.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to query.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_intersectionarrays"></a>`_.intersection([arrays])`
-<a href="#_intersectionarrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6079 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.intersection "See the npm package")
+<a href="#_intersectionarrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6620 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.intersection "See the npm package")
Creates an array of unique values that are included in all given arrays
using [`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
-for equality comparisons.
+for equality comparisons. The order of result values is determined by the
+order they occur in the first array.
+#### Since
+0.1.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
#### Returns
-*(Array)*: Returns the new array of shared values.
+*(Array)*: Returns the new array of intersecting values.
#### Example
```js
<!-- div -->
### <a id="_intersectionbyarrays-iteratee_identity"></a>`_.intersectionBy([arrays], [iteratee=_.identity])`
-<a href="#_intersectionbyarrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6106 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.intersectionby "See the npm package")
+<a href="#_intersectionbyarrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6650 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.intersectionby "See the npm package")
This method is like `_.intersection` except that it accepts `iteratee`
which is invoked for each element of each `arrays` to generate the criterion
-by which uniqueness is computed. The iteratee is invoked with one argument: (value).
+by which they're compared. Result values are chosen from the first array.
+The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns the new array of shared values.
+*(Array)*: Returns the new array of intersecting values.
#### Example
```js
<!-- div -->
### <a id="_intersectionwitharrays-comparator"></a>`_.intersectionWith([arrays], [comparator])`
-<a href="#_intersectionwitharrays-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6139 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.intersectionwith "See the npm package")
+<a href="#_intersectionwitharrays-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6685 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.intersectionwith "See the npm package")
This method is like `_.intersection` except that it accepts `comparator`
-which is invoked to compare elements of `arrays`. The comparator is invoked
-with two arguments: (arrVal, othVal).
+which is invoked to compare elements of `arrays`. Result values are chosen
+from the first array. The comparator is invoked with two arguments:<br>
+*(arrVal, othVal)*.
+#### Since
+4.0.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
2. `[comparator]` *(Function)*: The comparator invoked per element.
#### Returns
-*(Array)*: Returns the new array of shared values.
+*(Array)*: Returns the new array of intersecting values.
#### Example
```js
<!-- div -->
### <a id="_joinarray-separator-"></a>`_.join(array, [separator=','])`
-<a href="#_joinarray-separator-">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6167 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.join "See the npm package")
+<a href="#_joinarray-separator-">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6714 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.join "See the npm package")
Converts all elements in `array` into a string separated by `separator`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to convert.
2. `[separator=',']` *(string)*: The element separator.
#### Returns
-*(string)*: Returns the joined string.
+*(string)*: Returns the joined string.
#### Example
```js
<!-- div -->
### <a id="_lastarray"></a>`_.last(array)`
-<a href="#_lastarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6184 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.last "See the npm package")
+<a href="#_lastarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6732 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.last "See the npm package")
Gets the last element of `array`.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to query.
#### Returns
-*(*)*: Returns the last element of `array`.
+*(*)*: Returns the last element of `array`.
#### Example
```js
<!-- div -->
### <a id="_lastindexofarray-value-fromindexarraylength-1"></a>`_.lastIndexOf(array, value, [fromIndex=array.length-1])`
-<a href="#_lastindexofarray-value-fromindexarraylength-1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6209 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lastindexof "See the npm package")
+<a href="#_lastindexofarray-value-fromindexarraylength-1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6758 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lastindexof "See the npm package")
This method is like `_.indexOf` except that it iterates over elements of
`array` from right to left.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to search.
2. `value` *(*)*: The value to search for.
3. `[fromIndex=array.length-1]` *(number)*: The index to search from.
#### Returns
-*(number)*: Returns the index of the matched value, else `-1`.
+*(number)*: Returns the index of the matched value, else `-1`.
#### Example
```js
<!-- div -->
+### <a id="_ntharray-n0"></a>`_.nth(array, [n=0])`
+<a href="#_ntharray-n0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6804 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.nth "See the npm package")
+
+Gets the nth element of `array`. If `n` is negative, the nth element
+from the end is returned.
+
+#### Since
+4.11.0
+#### Arguments
+1. `array` *(Array)*: The array to query.
+2. `[n=0]` *(number)*: The index of the element to return.
+
+#### Returns
+*(*)*: Returns the nth element of `array`.
+
+#### Example
+```js
+var array = ['a', 'b', 'c', 'd'];
+
+_.nth(array, 1);
+// => 'b'
+
+_.nth(array, -2);
+// => 'c';
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_pullarray-values"></a>`_.pull(array, [values])`
-<a href="#_pullarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6252 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pull "See the npm package")
+<a href="#_pullarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6831 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pull "See the npm package")
Removes all given values from `array` using
[`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
**Note:** Unlike `_.without`, this method mutates `array`. Use `_.remove`
to remove elements from an array by predicate.
+#### Since
+2.0.0
#### Arguments
1. `array` *(Array)*: The array to modify.
2. `[values]` *(...*)*: The values to remove.
#### Returns
-*(Array)*: Returns `array`.
+*(Array)*: Returns `array`.
#### Example
```js
<!-- div -->
### <a id="_pullallarray-values"></a>`_.pullAll(array, values)`
-<a href="#_pullallarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6273 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullall "See the npm package")
+<a href="#_pullallarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6853 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullall "See the npm package")
This method is like `_.pull` except that it accepts an array of values to remove.
<br>
<br>
**Note:** Unlike `_.difference`, this method mutates `array`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to modify.
2. `values` *(Array)*: The values to remove.
#### Returns
-*(Array)*: Returns `array`.
+*(Array)*: Returns `array`.
#### Example
```js
<!-- div -->
### <a id="_pullallbyarray-values-iteratee_identity"></a>`_.pullAllBy(array, values, [iteratee=_.identity])`
-<a href="#_pullallbyarray-values-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6301 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullallby "See the npm package")
+<a href="#_pullallbyarray-values-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6883 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullallby "See the npm package")
This method is like `_.pullAll` except that it accepts `iteratee` which is
invoked for each element of `array` and `values` to generate the criterion
-by which uniqueness is computed. The iteratee is invoked with one argument: (value).
+by which they're compared. The iteratee is invoked with one argument: *(value)*.
<br>
<br>
**Note:** Unlike `_.differenceBy`, this method mutates `array`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to modify.
2. `values` *(Array)*: The values to remove.
-3. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+3. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns `array`.
+*(Array)*: Returns `array`.
#### Example
```js
<!-- div -->
+### <a id="_pullallwitharray-values-comparator"></a>`_.pullAllWith(array, values, [comparator])`
+<a href="#_pullallwitharray-values-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6912 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullallwith "See the npm package")
+
+This method is like `_.pullAll` except that it accepts `comparator` which
+is invoked to compare elements of `array` to `values`. The comparator is
+invoked with two arguments: *(arrVal, othVal)*.
+<br>
+<br>
+**Note:** Unlike `_.differenceWith`, this method mutates `array`.
+
+#### Since
+4.6.0
+#### Arguments
+1. `array` *(Array)*: The array to modify.
+2. `values` *(Array)*: The values to remove.
+3. `[comparator]` *(Function)*: The comparator invoked per element.
+
+#### Returns
+*(Array)*: Returns `array`.
+
+#### Example
+```js
+var array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }];
+
+_.pullAllWith(array, [{ 'x': 3, 'y': 4 }], _.isEqual);
+console.log(array);
+// => [{ 'x': 1, 'y': 2 }, { 'x': 5, 'y': 6 }]
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_pullatarray-indexes"></a>`_.pullAt(array, [indexes])`
-<a href="#_pullatarray-indexes">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6331 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullat "See the npm package")
+<a href="#_pullatarray-indexes">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6942 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pullat "See the npm package")
Removes elements from `array` corresponding to `indexes` and returns an
array of removed elements.
<br>
**Note:** Unlike `_.at`, this method mutates `array`.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to modify.
-2. `[indexes]` *(...(number|number[])*: The indexes of elements to remove, specified individually or in arrays.
+2. `[indexes]` *(...(number|number[]))*: The indexes of elements to remove.
#### Returns
-*(Array)*: Returns the new array of removed elements.
+*(Array)*: Returns the new array of removed elements.
#### Example
```js
<!-- div -->
### <a id="_removearray-predicate_identity"></a>`_.remove(array, [predicate=_.identity])`
-<a href="#_removearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6366 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.remove "See the npm package")
+<a href="#_removearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L6984 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.remove "See the npm package")
Removes all elements from `array` that `predicate` returns truthy for
and returns an array of the removed elements. The predicate is invoked
-with three arguments: (value, index, array).
+with three arguments: *(value, index, array)*.
<br>
<br>
**Note:** Unlike `_.filter`, this method mutates `array`. Use `_.pull`
to pull elements from an array by value.
+#### Since
+2.0.0
#### Arguments
1. `array` *(Array)*: The array to modify.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the new array of removed elements.
+*(Array)*: Returns the new array of removed elements.
#### Example
```js
<!-- div -->
-### <a id="_reverse"></a>`_.reverse()`
-<a href="#_reverse">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6408 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reverse "See the npm package")
+### <a id="_reversearray"></a>`_.reverse(array)`
+<a href="#_reversearray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7028 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reverse "See the npm package")
Reverses `array` so that the first element becomes the last, the second
element becomes the second to last, and so on.
**Note:** This method mutates `array` and is based on
[`Array#reverse`](https://mdn.io/Array/reverse).
+#### Since
+4.0.0
+#### Arguments
+1. `array` *(Array)*: The array to modify.
+
#### Returns
-*(Array)*: Returns `array`.
+*(Array)*: Returns `array`.
#### Example
```js
<!-- div -->
### <a id="_slicearray-start0-endarraylength"></a>`_.slice(array, [start=0], [end=array.length])`
-<a href="#_slicearray-start0-endarraylength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6426 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.slice "See the npm package")
+<a href="#_slicearray-start0-endarraylength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7048 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.slice "See the npm package")
Creates a slice of `array` from `start` up to, but not including, `end`.
<br>
<br>
-**Note:** This method is used instead of [`Array#slice`](https://mdn.io/Array/slice)
-to ensure dense arrays are returned.
+**Note:** This method is used instead of
+[`Array#slice`](https://mdn.io/Array/slice) to ensure dense arrays are
+returned.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to slice.
2. `[start=0]` *(number)*: The start position.
3. `[end=array.length]` *(number)*: The end position.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
* * *
<!-- div -->
### <a id="_sortedindexarray-value"></a>`_.sortedIndex(array, value)`
-<a href="#_sortedindexarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6460 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedindex "See the npm package")
+<a href="#_sortedindexarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7084 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedindex "See the npm package")
-Uses a binary search to determine the lowest index at which `value` should
-be inserted into `array` in order to maintain its sort order.
+Uses a binary search to determine the lowest index at which `value`
+should be inserted into `array` in order to maintain its sort order.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The sorted array to inspect.
2. `value` *(*)*: The value to evaluate.
#### Returns
-*(number)*: Returns the index at which `value` should be inserted into `array`.
+*(number)*: Returns the index at which `value` should be inserted into `array`.
#### Example
```js
<!-- div -->
### <a id="_sortedindexbyarray-value-iteratee_identity"></a>`_.sortedIndexBy(array, value, [iteratee=_.identity])`
-<a href="#_sortedindexbyarray-value-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6487 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedindexby "See the npm package")
+<a href="#_sortedindexbyarray-value-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7114 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedindexby "See the npm package")
This method is like `_.sortedIndex` except that it accepts `iteratee`
which is invoked for `value` and each element of `array` to compute their
-sort ranking. The iteratee is invoked with one argument: (value).
+sort ranking. The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The sorted array to inspect.
2. `value` *(*)*: The value to evaluate.
-3. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+3. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(number)*: Returns the index at which `value` should be inserted into `array`.
+*(number)*: Returns the index at which `value` should be inserted into `array`.
#### Example
```js
<!-- div -->
### <a id="_sortedindexofarray-value"></a>`_.sortedIndexOf(array, value)`
-<a href="#_sortedindexofarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6506 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedindexof "See the npm package")
+<a href="#_sortedindexofarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7134 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedindexof "See the npm package")
This method is like `_.indexOf` except that it performs a binary
search on a sorted `array`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to search.
2. `value` *(*)*: The value to search for.
#### Returns
-*(number)*: Returns the index of the matched value, else `-1`.
+*(number)*: Returns the index of the matched value, else `-1`.
#### Example
```js
<!-- div -->
### <a id="_sortedlastindexarray-value"></a>`_.sortedLastIndex(array, value)`
-<a href="#_sortedlastindexarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6533 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedlastindex "See the npm package")
+<a href="#_sortedlastindexarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7163 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedlastindex "See the npm package")
This method is like `_.sortedIndex` except that it returns the highest
index at which `value` should be inserted into `array` in order to
maintain its sort order.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The sorted array to inspect.
2. `value` *(*)*: The value to evaluate.
#### Returns
-*(number)*: Returns the index at which `value` should be inserted into `array`.
+*(number)*: Returns the index at which `value` should be inserted into `array`.
#### Example
```js
<!-- div -->
### <a id="_sortedlastindexbyarray-value-iteratee_identity"></a>`_.sortedLastIndexBy(array, value, [iteratee=_.identity])`
-<a href="#_sortedlastindexbyarray-value-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6555 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedlastindexby "See the npm package")
+<a href="#_sortedlastindexbyarray-value-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7188 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedlastindexby "See the npm package")
This method is like `_.sortedLastIndex` except that it accepts `iteratee`
which is invoked for `value` and each element of `array` to compute their
-sort ranking. The iteratee is invoked with one argument: (value).
+sort ranking. The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The sorted array to inspect.
2. `value` *(*)*: The value to evaluate.
-3. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+3. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(number)*: Returns the index at which `value` should be inserted into `array`.
+*(number)*: Returns the index at which `value` should be inserted into `array`.
#### Example
```js
<!-- div -->
### <a id="_sortedlastindexofarray-value"></a>`_.sortedLastIndexOf(array, value)`
-<a href="#_sortedlastindexofarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6574 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedlastindexof "See the npm package")
+<a href="#_sortedlastindexofarray-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7208 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortedlastindexof "See the npm package")
This method is like `_.lastIndexOf` except that it performs a binary
search on a sorted `array`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to search.
2. `value` *(*)*: The value to search for.
#### Returns
-*(number)*: Returns the index of the matched value, else `-1`.
+*(number)*: Returns the index of the matched value, else `-1`.
#### Example
```js
<!-- div -->
### <a id="_sorteduniqarray"></a>`_.sortedUniq(array)`
-<a href="#_sorteduniqarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6599 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sorteduniq "See the npm package")
+<a href="#_sorteduniqarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7234 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sorteduniq "See the npm package")
This method is like `_.uniq` except that it's designed and optimized
for sorted arrays.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
#### Returns
-*(Array)*: Returns the new duplicate free array.
+*(Array)*: Returns the new duplicate free array.
#### Example
```js
<!-- div -->
### <a id="_sorteduniqbyarray-iteratee"></a>`_.sortedUniqBy(array, [iteratee])`
-<a href="#_sorteduniqbyarray-iteratee">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6620 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sorteduniqby "See the npm package")
+<a href="#_sorteduniqbyarray-iteratee">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7256 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sorteduniqby "See the npm package")
This method is like `_.uniqBy` except that it's designed and optimized
for sorted arrays.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
2. `[iteratee]` *(Function)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns the new duplicate free array.
+*(Array)*: Returns the new duplicate free array.
#### Example
```js
<!-- div -->
### <a id="_tailarray"></a>`_.tail(array)`
-<a href="#_tailarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6639 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tail "See the npm package")
+<a href="#_tailarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7276 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tail "See the npm package")
Gets all but the first element of `array`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_takearray-n1"></a>`_.take(array, [n=1])`
-<a href="#_takearray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6667 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.take "See the npm package")
+<a href="#_takearray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7305 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.take "See the npm package")
Creates a slice of `array` with `n` elements taken from the beginning.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to query.
2. `[n=1]` *(number)*: The number of elements to take.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_takerightarray-n1"></a>`_.takeRight(array, [n=1])`
-<a href="#_takerightarray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6699 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.takeright "See the npm package")
+<a href="#_takerightarray-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7338 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.takeright "See the npm package")
Creates a slice of `array` with `n` elements taken from the end.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
2. `[n=1]` *(number)*: The number of elements to take.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_takerightwhilearray-predicate_identity"></a>`_.takeRightWhile(array, [predicate=_.identity])`
-<a href="#_takerightwhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6743 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.takerightwhile "See the npm package")
+<a href="#_takerightwhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7384 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.takerightwhile "See the npm package")
Creates a slice of `array` with elements taken from the end. Elements are
-taken until `predicate` returns falsey. The predicate is invoked with three
-arguments: (value, index, array).
+taken until `predicate` returns falsey. The predicate is invoked with
+three arguments: *(value, index, array)*.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_takewhilearray-predicate_identity"></a>`_.takeWhile(array, [predicate=_.identity])`
-<a href="#_takewhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6783 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.takewhile "See the npm package")
+<a href="#_takewhilearray-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7426 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.takewhile "See the npm package")
Creates a slice of `array` with elements taken from the beginning. Elements
are taken until `predicate` returns falsey. The predicate is invoked with
-three arguments: (value, index, array).
+three arguments: *(value, index, array)*.
+#### Since
+3.0.0
#### Arguments
1. `array` *(Array)*: The array to query.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the slice of `array`.
+*(Array)*: Returns the slice of `array`.
#### Example
```js
<!-- div -->
### <a id="_unionarrays"></a>`_.union([arrays])`
-<a href="#_unionarrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6804 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.union "See the npm package")
+<a href="#_unionarrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7448 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.union "See the npm package")
Creates an array of unique values, in order, from all given arrays using
[`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
for equality comparisons.
+#### Since
+0.1.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
#### Returns
-*(Array)*: Returns the new array of combined values.
+*(Array)*: Returns the new array of combined values.
#### Example
```js
<!-- div -->
### <a id="_unionbyarrays-iteratee_identity"></a>`_.unionBy([arrays], [iteratee=_.identity])`
-<a href="#_unionbyarrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6828 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unionby "See the npm package")
+<a href="#_unionbyarrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7475 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unionby "See the npm package")
This method is like `_.union` except that it accepts `iteratee` which is
-invoked for each element of each `arrays` to generate the criterion by which
-uniqueness is computed. The iteratee is invoked with one argument: (value).
+invoked for each element of each `arrays` to generate the criterion by
+which uniqueness is computed. The iteratee is invoked with one argument:<br>
+*(value)*.
+#### Since
+4.0.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns the new array of combined values.
+*(Array)*: Returns the new array of combined values.
#### Example
```js
<!-- div -->
### <a id="_unionwitharrays-comparator"></a>`_.unionWith([arrays], [comparator])`
-<a href="#_unionwitharrays-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6855 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unionwith "See the npm package")
+<a href="#_unionwitharrays-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7503 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unionwith "See the npm package")
This method is like `_.union` except that it accepts `comparator` which
is invoked to compare elements of `arrays`. The comparator is invoked
-with two arguments: (arrVal, othVal).
+with two arguments: *(arrVal, othVal)*.
+#### Since
+4.0.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
2. `[comparator]` *(Function)*: The comparator invoked per element.
#### Returns
-*(Array)*: Returns the new array of combined values.
+*(Array)*: Returns the new array of combined values.
#### Example
```js
<!-- div -->
### <a id="_uniqarray"></a>`_.uniq(array)`
-<a href="#_uniqarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6879 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniq "See the npm package")
+<a href="#_uniqarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7528 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniq "See the npm package")
Creates a duplicate-free version of an array, using
[`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
-for equality comparisons, in which only the first occurrence of each element
-is kept.
+for equality comparisons, in which only the first occurrence of each
+element is kept.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
#### Returns
-*(Array)*: Returns the new duplicate free array.
+*(Array)*: Returns the new duplicate free array.
#### Example
```js
<!-- div -->
### <a id="_uniqbyarray-iteratee_identity"></a>`_.uniqBy(array, [iteratee=_.identity])`
-<a href="#_uniqbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6905 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniqby "See the npm package")
+<a href="#_uniqbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7556 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniqby "See the npm package")
This method is like `_.uniq` except that it accepts `iteratee` which is
invoked for each element in `array` to generate the criterion by which
-uniqueness is computed. The iteratee is invoked with one argument: (value).
+uniqueness is computed. The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns the new duplicate free array.
+*(Array)*: Returns the new duplicate free array.
#### Example
```js
<!-- div -->
### <a id="_uniqwitharray-comparator"></a>`_.uniqWith(array, [comparator])`
-<a href="#_uniqwitharray-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6929 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniqwith "See the npm package")
+<a href="#_uniqwitharray-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7581 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniqwith "See the npm package")
This method is like `_.uniq` except that it accepts `comparator` which
is invoked to compare elements of `array`. The comparator is invoked with
-two arguments: (arrVal, othVal).
+two arguments: *(arrVal, othVal)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to inspect.
2. `[comparator]` *(Function)*: The comparator invoked per element.
#### Returns
-*(Array)*: Returns the new duplicate free array.
+*(Array)*: Returns the new duplicate free array.
#### Example
```js
<!-- div -->
### <a id="_unziparray"></a>`_.unzip(array)`
-<a href="#_unziparray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6953 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unzip "See the npm package")
+<a href="#_unziparray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7606 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unzip "See the npm package")
This method is like `_.zip` except that it accepts an array of grouped
elements and creates an array regrouping the elements to their pre-zip
configuration.
+#### Since
+1.2.0
#### Arguments
1. `array` *(Array)*: The array of grouped elements to process.
#### Returns
-*(Array)*: Returns the new array of regrouped elements.
+*(Array)*: Returns the new array of regrouped elements.
#### Example
```js
<!-- div -->
### <a id="_unzipwitharray-iteratee_identity"></a>`_.unzipWith(array, [iteratee=_.identity])`
-<a href="#_unzipwitharray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L6988 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unzipwith "See the npm package")
+<a href="#_unzipwitharray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7643 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unzipwith "See the npm package")
This method is like `_.unzip` except that it accepts `iteratee` to specify
how regrouped values should be combined. The iteratee is invoked with the
-elements of each group: (...group).
+elements of each group: *(...group)*.
+#### Since
+3.8.0
#### Arguments
1. `array` *(Array)*: The array of grouped elements to process.
2. `[iteratee=_.identity]` *(Function)*: The function to combine regrouped values.
#### Returns
-*(Array)*: Returns the new array of regrouped elements.
+*(Array)*: Returns the new array of regrouped elements.
#### Example
```js
<!-- div -->
### <a id="_withoutarray-values"></a>`_.without(array, [values])`
-<a href="#_withoutarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7017 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.without "See the npm package")
+<a href="#_withoutarray-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7674 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.without "See the npm package")
Creates an array excluding all given values using
[`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
for equality comparisons.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to filter.
2. `[values]` *(...*)*: The values to exclude.
#### Returns
-*(Array)*: Returns the new array of filtered values.
+*(Array)*: Returns the new array of filtered values.
#### Example
```js
<!-- div -->
### <a id="_xorarrays"></a>`_.xor([arrays])`
-<a href="#_xorarrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7037 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.xor "See the npm package")
+<a href="#_xorarrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7698 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.xor "See the npm package")
-Creates an array of unique values that is the [symmetric difference](https://en.wikipedia.org/wiki/Symmetric_difference)
-of the given arrays.
+Creates an array of unique values that is the
+[symmetric difference](https://en.wikipedia.org/wiki/Symmetric_difference)
+of the given arrays. The order of result values is determined by the order
+they occur in the arrays.
+#### Since
+2.4.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
#### Returns
-*(Array)*: Returns the new array of values.
+*(Array)*: Returns the new array of values.
#### Example
```js
<!-- div -->
### <a id="_xorbyarrays-iteratee_identity"></a>`_.xorBy([arrays], [iteratee=_.identity])`
-<a href="#_xorbyarrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7061 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.xorby "See the npm package")
+<a href="#_xorbyarrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7725 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.xorby "See the npm package")
This method is like `_.xor` except that it accepts `iteratee` which is
-invoked for each element of each `arrays` to generate the criterion by which
-uniqueness is computed. The iteratee is invoked with one argument: (value).
+invoked for each element of each `arrays` to generate the criterion by
+which by which they're compared. The iteratee is invoked with one argument:<br>
+*(value)*.
+#### Since
+4.0.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Array)*: Returns the new array of values.
+*(Array)*: Returns the new array of values.
#### Example
```js
<!-- div -->
### <a id="_xorwitharrays-comparator"></a>`_.xorWith([arrays], [comparator])`
-<a href="#_xorwitharrays-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7088 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.xorwith "See the npm package")
+<a href="#_xorwitharrays-comparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7753 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.xorwith "See the npm package")
This method is like `_.xor` except that it accepts `comparator` which is
invoked to compare elements of `arrays`. The comparator is invoked with
-two arguments: (arrVal, othVal).
+two arguments: *(arrVal, othVal)*.
+#### Since
+4.0.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to inspect.
2. `[comparator]` *(Function)*: The comparator invoked per element.
#### Returns
-*(Array)*: Returns the new array of values.
+*(Array)*: Returns the new array of values.
#### Example
```js
<!-- div -->
### <a id="_ziparrays"></a>`_.zip([arrays])`
-<a href="#_ziparrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7111 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zip "See the npm package")
+<a href="#_ziparrays">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7777 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zip "See the npm package")
-Creates an array of grouped elements, the first of which contains the first
-elements of the given arrays, the second of which contains the second elements
-of the given arrays, and so on.
+Creates an array of grouped elements, the first of which contains the
+first elements of the given arrays, the second of which contains the
+second elements of the given arrays, and so on.
+#### Since
+0.1.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to process.
#### Returns
-*(Array)*: Returns the new array of grouped elements.
+*(Array)*: Returns the new array of grouped elements.
#### Example
```js
<!-- div -->
### <a id="_zipobjectprops-values"></a>`_.zipObject([props=[]], [values=[]])`
-<a href="#_zipobjectprops-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7128 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zipobject "See the npm package")
+<a href="#_zipobjectprops-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7795 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zipobject "See the npm package")
This method is like `_.fromPairs` except that it accepts two arrays,
-one of property names and one of corresponding values.
+one of property identifiers and one of corresponding values.
+#### Since
+0.4.0
#### Arguments
-1. `[props=[]]` *(Array)*: The property names.
+1. `[props=[]]` *(Array)*: The property identifiers.
2. `[values=[]]` *(Array)*: The property values.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_zipobjectdeepprops-values"></a>`_.zipObjectDeep([props=[]], [values=[]])`
-<a href="#_zipobjectdeepprops-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7146 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zipobjectdeep "See the npm package")
+<a href="#_zipobjectdeepprops-values">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7814 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zipobjectdeep "See the npm package")
This method is like `_.zipObject` except that it supports property paths.
+#### Since
+4.1.0
#### Arguments
-1. `[props=[]]` *(Array)*: The property names.
+1. `[props=[]]` *(Array)*: The property identifiers.
2. `[values=[]]` *(Array)*: The property values.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_zipwitharrays-iteratee_identity"></a>`_.zipWith([arrays], [iteratee=_.identity])`
-<a href="#_zipwitharrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7168 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zipwith "See the npm package")
+<a href="#_zipwitharrays-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7837 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.zipwith "See the npm package")
This method is like `_.zip` except that it accepts `iteratee` to specify
how grouped values should be combined. The iteratee is invoked with the
-elements of each group: (...group).
+elements of each group: *(...group)*.
+#### Since
+3.8.0
#### Arguments
1. `[arrays]` *(...Array)*: The arrays to process.
2. `[iteratee=_.identity]` *(Function)*: The function to combine grouped values.
#### Returns
-*(Array)*: Returns the new array of grouped elements.
+*(Array)*: Returns the new array of grouped elements.
#### Example
```js
<!-- div -->
### <a id="_countbycollection-iteratee_identity"></a>`_.countBy(collection, [iteratee=_.identity])`
-<a href="#_countbycollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7559 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.countby "See the npm package")
+<a href="#_countbycollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8220 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.countby "See the npm package")
Creates an object composed of keys generated from the results of running
-each element of `collection` through `iteratee`. The corresponding value
-of each key is the number of times the key was returned by `iteratee`.
-The iteratee is invoked with one argument: (value).
+each element of `collection` thru `iteratee`. The corresponding value of
+each key is the number of times the key was returned by `iteratee`. The
+iteratee is invoked with one argument: *(value)*.
+#### Since
+0.5.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee to transform keys.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee to transform keys.
#### Returns
-*(Object)*: Returns the composed aggregate object.
+*(Object)*: Returns the composed aggregate object.
#### Example
```js
<!-- div -->
### <a id="_everycollection-predicate_identity"></a>`_.every(collection, [predicate=_.identity])`
-<a href="#_everycollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7597 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.every "See the npm package")
+<a href="#_everycollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8261 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.every "See the npm package")
Checks if `predicate` returns truthy for **all** elements of `collection`.
Iteration is stopped once `predicate` returns falsey. The predicate is
-invoked with three arguments: (value, index|key, collection).
+invoked with three arguments: *(value, index|key, collection)*.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(boolean)*: Returns `true` if all elements pass the predicate check, else `false`.
+*(boolean)*: Returns `true` if all elements pass the predicate check, else `false`.
#### Example
```js
// => false
var users = [
- { 'user': 'barney', 'active': false },
- { 'user': 'fred', 'active': false }
+ { 'user': 'barney', 'age': 36, 'active': false },
+ { 'user': 'fred', 'age': 40, 'active': false }
];
// The `_.matches` iteratee shorthand.
<!-- div -->
### <a id="_filtercollection-predicate_identity"></a>`_.filter(collection, [predicate=_.identity])`
-<a href="#_filtercollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7638 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.filter "See the npm package")
+<a href="#_filtercollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8305 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.filter "See the npm package")
Iterates over elements of `collection`, returning an array of all elements
-`predicate` returns truthy for. The predicate is invoked with three arguments:<br>
-(value, index|key, collection).
+`predicate` returns truthy for. The predicate is invoked with three
+arguments: *(value, index|key, collection)*.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the new filtered array.
+*(Array)*: Returns the new filtered array.
#### Example
```js
<!-- div -->
### <a id="_findcollection-predicate_identity"></a>`_.find(collection, [predicate=_.identity])`
-<a href="#_findcollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7677 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.find "See the npm package")
+<a href="#_findcollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8346 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.find "See the npm package")
Iterates over elements of `collection`, returning the first element
-`predicate` returns truthy for. The predicate is invoked with three arguments:<br>
-(value, index|key, collection).
+`predicate` returns truthy for. The predicate is invoked with three
+arguments: *(value, index|key, collection)*.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to search.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(*)*: Returns the matched element, else `undefined`.
+*(*)*: Returns the matched element, else `undefined`.
#### Example
```js
<!-- div -->
### <a id="_findlastcollection-predicate_identity"></a>`_.findLast(collection, [predicate=_.identity])`
-<a href="#_findlastcollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7703 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findlast "See the npm package")
+<a href="#_findlastcollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8374 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findlast "See the npm package")
This method is like `_.find` except that it iterates over elements of
`collection` from right to left.
+#### Since
+2.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to search.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(*)*: Returns the matched element, else `undefined`.
+*(*)*: Returns the matched element, else `undefined`.
#### Example
```js
<!-- div -->
### <a id="_flatmapcollection-iteratee_identity"></a>`_.flatMap(collection, [iteratee=_.identity])`
-<a href="#_flatmapcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7732 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flatmap "See the npm package")
+<a href="#_flatmapcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8405 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flatmap "See the npm package")
-Creates an array of flattened values by running each element in `collection`
-through `iteratee` and concating its result to the other mapped values.
-The iteratee is invoked with three arguments: (value, index|key, collection).
+Creates a flattened array of values by running each element in `collection`
+thru `iteratee` and flattening the mapped results. The iteratee is invoked
+with three arguments: *(value, index|key, collection)*.
+#### Since
+4.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the new flattened array.
+*(Array)*: Returns the new flattened array.
#### Example
```js
<!-- div -->
+### <a id="_flatmapdeepcollection-iteratee_identity"></a>`_.flatMapDeep(collection, [iteratee=_.identity])`
+<a href="#_flatmapdeepcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8430 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flatmapdeep "See the npm package")
+
+This method is like `_.flatMap` except that it recursively flattens the
+mapped results.
+
+#### Since
+4.7.0
+#### Arguments
+1. `collection` *(Array|Object)*: The collection to iterate over.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
+
+#### Returns
+*(Array)*: Returns the new flattened array.
+
+#### Example
+```js
+function duplicate(n) {
+ return [[[n, n]]];
+}
+
+_.flatMapDeep([1, 2], duplicate);
+// => [1, 1, 2, 2]
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
+### <a id="_flatmapdepthcollection-iteratee_identity-depth1"></a>`_.flatMapDepth(collection, [iteratee=_.identity], [depth=1])`
+<a href="#_flatmapdepthcollection-iteratee_identity-depth1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8456 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flatmapdepth "See the npm package")
+
+This method is like `_.flatMap` except that it recursively flattens the
+mapped results up to `depth` times.
+
+#### Since
+4.7.0
+#### Arguments
+1. `collection` *(Array|Object)*: The collection to iterate over.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
+3. `[depth=1]` *(number)*: The maximum recursion depth.
+
+#### Returns
+*(Array)*: Returns the new flattened array.
+
+#### Example
+```js
+function duplicate(n) {
+ return [[[n, n]]];
+}
+
+_.flatMapDepth([1, 2], duplicate, 2);
+// => [[1, 1], [2, 2]]
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_foreachcollection-iteratee_identity"></a>`_.forEach(collection, [iteratee=_.identity])`
-<a href="#_foreachcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7764 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.foreach "See the npm package")
+<a href="#_foreachcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8491 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.foreach "See the npm package")
-Iterates over elements of `collection` invoking `iteratee` for each element.
-The iteratee is invoked with three arguments: (value, index|key, collection).
+Iterates over elements of `collection` and invokes `iteratee` for each element.
+The iteratee is invoked with three arguments: *(value, index|key, collection)*.
Iteratee functions may exit iteration early by explicitly returning `false`.
<br>
<br>
-**Note:** As with other "Collections" methods, objects with a "length" property
-are iterated like arrays. To avoid this behavior use `_.forIn` or `_.forOwn`
-for object iteration.
+**Note:** As with other "Collections" methods, objects with a "length"
+property are iterated like arrays. To avoid this behavior use `_.forIn`
+or `_.forOwn` for object iteration.
+#### Since
+0.1.0
#### Aliases
*_.each*
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Array|Object)*: Returns `collection`.
+*(*)*: Returns `collection`.
#### Example
```js
_([1, 2]).forEach(function(value) {
console.log(value);
});
-// => logs `1` then `2`
+// => Logs `1` then `2`.
_.forEach({ 'a': 1, 'b': 2 }, function(value, key) {
console.log(key);
});
-// => logs 'a' then 'b' (iteration order is not guaranteed)
+// => Logs 'a' then 'b' (iteration order is not guaranteed).
```
* * *
<!-- div -->
### <a id="_foreachrightcollection-iteratee_identity"></a>`_.forEachRight(collection, [iteratee=_.identity])`
-<a href="#_foreachrightcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7788 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.foreachright "See the npm package")
+<a href="#_foreachrightcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8517 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.foreachright "See the npm package")
This method is like `_.forEach` except that it iterates over elements of
`collection` from right to left.
+#### Since
+2.0.0
#### Aliases
*_.eachRight*
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Array|Object)*: Returns `collection`.
+*(*)*: Returns `collection`.
#### Example
```js
_.forEachRight([1, 2], function(value) {
console.log(value);
});
-// => logs `2` then `1`
+// => Logs `2` then `1`.
```
* * *
<!-- div -->
### <a id="_groupbycollection-iteratee_identity"></a>`_.groupBy(collection, [iteratee=_.identity])`
-<a href="#_groupbycollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7815 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.groupby "See the npm package")
+<a href="#_groupbycollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8547 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.groupby "See the npm package")
Creates an object composed of keys generated from the results of running
-each element of `collection` through `iteratee`. The corresponding value
-of each key is an array of elements responsible for generating the key.
-The iteratee is invoked with one argument: (value).
+each element of `collection` thru `iteratee`. The order of grouped values
+is determined by the order they occur in `collection`. The corresponding
+value of each key is an array of elements responsible for generating the
+key. The iteratee is invoked with one argument: *(value)*.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee to transform keys.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee to transform keys.
#### Returns
-*(Object)*: Returns the composed aggregate object.
+*(Object)*: Returns the composed aggregate object.
#### Example
```js
<!-- div -->
### <a id="_includescollection-value-fromindex0"></a>`_.includes(collection, value, [fromIndex=0])`
-<a href="#_includescollection-value-fromindex0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7851 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.includes "See the npm package")
+<a href="#_includescollection-value-fromindex0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8585 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.includes "See the npm package")
-Checks if `value` is in `collection`. If `collection` is a string it's checked
-for a substring of `value`, otherwise [`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
+Checks if `value` is in `collection`. If `collection` is a string, it's
+checked for a substring of `value`, otherwise
+[`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
is used for equality comparisons. If `fromIndex` is negative, it's used as
the offset from the end of `collection`.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object|string)*: The collection to search.
2. `value` *(*)*: The value to search for.
3. `[fromIndex=0]` *(number)*: The index to search from.
#### Returns
-*(boolean)*: Returns `true` if `value` is found, else `false`.
+*(boolean)*: Returns `true` if `value` is found, else `false`.
#### Example
```js
<!-- div -->
### <a id="_invokemapcollection-path-args"></a>`_.invokeMap(collection, path, [args])`
-<a href="#_invokemapcollection-path-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7886 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invokemap "See the npm package")
+<a href="#_invokemapcollection-path-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8621 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invokemap "See the npm package")
Invokes the method at `path` of each element in `collection`, returning
an array of the results of each invoked method. Any additional arguments
-are provided to each invoked method. If `methodName` is a function it's
-invoked for, and `this` bound to, each element in `collection`.
+are provided to each invoked method. If `methodName` is a function, it's
+invoked for and `this` bound to, each element in `collection`.
+#### Since
+4.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
2. `path` *(Array|Function|string)*: The path of the method to invoke or the function invoked per iteration.
3. `[args]` *(...*)*: The arguments to invoke each method with.
#### Returns
-*(Array)*: Returns the array of results.
+*(Array)*: Returns the array of results.
#### Example
```js
<!-- div -->
### <a id="_keybycollection-iteratee_identity"></a>`_.keyBy(collection, [iteratee=_.identity])`
-<a href="#_keybycollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7926 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.keyby "See the npm package")
+<a href="#_keybycollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8663 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.keyby "See the npm package")
Creates an object composed of keys generated from the results of running
-each element of `collection` through `iteratee`. The corresponding value
-of each key is the last element responsible for generating the key. The
-iteratee is invoked with one argument: (value).
+each element of `collection` thru `iteratee`. The corresponding value of
+each key is the last element responsible for generating the key. The
+iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee to transform keys.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee to transform keys.
#### Returns
-*(Object)*: Returns the composed aggregate object.
+*(Object)*: Returns the composed aggregate object.
#### Example
```js
<!-- div -->
### <a id="_mapcollection-iteratee_identity"></a>`_.map(collection, [iteratee=_.identity])`
-<a href="#_mapcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7971 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.map "See the npm package")
+<a href="#_mapcollection-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8710 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.map "See the npm package")
-Creates an array of values by running each element in `collection` through
+Creates an array of values by running each element in `collection` thru
`iteratee`. The iteratee is invoked with three arguments:<br>
-(value, index|key, collection).
+*(value, index|key, collection)*.
<br>
<br>
Many lodash methods are guarded to work as iteratees for methods like
<br>
<br>
The guarded methods are:<br>
-`ary`, `curry`, `curryRight`, `drop`, `dropRight`, `every`, `fill`,
-`invert`, `parseInt`, `random`, `range`, `rangeRight`, `slice`, `some`,
-`sortBy`, `take`, `takeRight`, `template`, `trim`, `trimEnd`, `trimStart`,
-and `words`
+`ary`, `chunk`, `curry`, `curryRight`, `drop`, `dropRight`, `every`,
+`fill`, `invert`, `parseInt`, `random`, `range`, `rangeRight`, `repeat`,
+`sampleSize`, `slice`, `some`, `sortBy`, `split`, `take`, `takeRight`,
+`template`, `trim`, `trimEnd`, `trimStart`, and `words`
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the new mapped array.
+*(Array)*: Returns the new mapped array.
#### Example
```js
<!-- div -->
-### <a id="_orderbycollection-iteratees-_identity-orders"></a>`_.orderBy(collection, [iteratees=[_.identity]], [orders])`
-<a href="#_orderbycollection-iteratees-_identity-orders">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8003 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.orderby "See the npm package")
+### <a id="_orderbycollection-iteratees_identity-orders"></a>`_.orderBy(collection, [iteratees=[_.identity]], [orders])`
+<a href="#_orderbycollection-iteratees_identity-orders">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8744 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.orderby "See the npm package")
This method is like `_.sortBy` except that it allows specifying the sort
orders of the iteratees to sort by. If `orders` is unspecified, all values
are sorted in ascending order. Otherwise, specify an order of "desc" for
descending or "asc" for ascending sort order of corresponding values.
+#### Since
+4.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratees=[_.identity]]` *(Function[]|Object[]|string[])*: The iteratees to sort by.
+2. `[iteratees=[_.identity]]` *(Array[]|Function[]|Object[]|string[])*: The iteratees to sort by.
3. `[orders]` *(string[])*: The sort orders of `iteratees`.
#### Returns
-*(Array)*: Returns the new sorted array.
+*(Array)*: Returns the new sorted array.
#### Example
```js
var users = [
{ 'user': 'fred', 'age': 48 },
{ 'user': 'barney', 'age': 34 },
- { 'user': 'fred', 'age': 42 },
+ { 'user': 'fred', 'age': 40 },
{ 'user': 'barney', 'age': 36 }
];
// Sort by `user` in ascending order and by `age` in descending order.
_.orderBy(users, ['user', 'age'], ['asc', 'desc']);
-// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
+// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]]
```
* * *
<!-- div -->
### <a id="_partitioncollection-predicate_identity"></a>`_.partition(collection, [predicate=_.identity])`
-<a href="#_partitioncollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8052 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.partition "See the npm package")
+<a href="#_partitioncollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8795 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.partition "See the npm package")
Creates an array of elements split into two groups, the first of which
contains elements `predicate` returns truthy for, the second of which
contains elements `predicate` returns falsey for. The predicate is
-invoked with one argument: (value).
+invoked with one argument: *(value)*.
+#### Since
+3.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the array of grouped elements.
+*(Array)*: Returns the array of grouped elements.
#### Example
```js
<!-- div -->
### <a id="_reducecollection-iteratee_identity-accumulator"></a>`_.reduce(collection, [iteratee=_.identity], [accumulator])`
-<a href="#_reducecollection-iteratee_identity-accumulator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8091 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reduce "See the npm package")
+<a href="#_reducecollection-iteratee_identity-accumulator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8836 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reduce "See the npm package")
Reduces `collection` to a value which is the accumulated result of running
-each element in `collection` through `iteratee`, where each successive
+each element in `collection` thru `iteratee`, where each successive
invocation is supplied the return value of the previous. If `accumulator`
-is not given the first element of `collection` is used as the initial
+is not given, the first element of `collection` is used as the initial
value. The iteratee is invoked with four arguments:<br>
-(accumulator, value, index|key, collection).
+*(accumulator, value, index|key, collection)*.
<br>
<br>
Many lodash methods are guarded to work as iteratees for methods like
`assign`, `defaults`, `defaultsDeep`, `includes`, `merge`, `orderBy`,
and `sortBy`
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
3. `[accumulator]` *(*)*: The initial value.
#### Returns
-*(*)*: Returns the accumulated value.
+*(*)*: Returns the accumulated value.
#### Example
```js
<!-- div -->
### <a id="_reducerightcollection-iteratee_identity-accumulator"></a>`_.reduceRight(collection, [iteratee=_.identity], [accumulator])`
-<a href="#_reducerightcollection-iteratee_identity-accumulator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8118 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reduceright "See the npm package")
+<a href="#_reducerightcollection-iteratee_identity-accumulator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8865 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reduceright "See the npm package")
This method is like `_.reduce` except that it iterates over elements of
`collection` from right to left.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
3. `[accumulator]` *(*)*: The initial value.
#### Returns
-*(*)*: Returns the accumulated value.
+*(*)*: Returns the accumulated value.
#### Example
```js
<!-- div -->
### <a id="_rejectcollection-predicate_identity"></a>`_.reject(collection, [predicate=_.identity])`
-<a href="#_rejectcollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8157 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reject "See the npm package")
+<a href="#_rejectcollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8907 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.reject "See the npm package")
The opposite of `_.filter`; this method returns the elements of `collection`
that `predicate` does **not** return truthy for.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the new filtered array.
+*(Array)*: Returns the new filtered array.
#### Example
```js
<!-- div -->
### <a id="_samplecollection"></a>`_.sample(collection)`
-<a href="#_samplecollection">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8178 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sample "See the npm package")
+<a href="#_samplecollection">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8929 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sample "See the npm package")
Gets a random element from `collection`.
+#### Since
+2.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to sample.
#### Returns
-*(*)*: Returns the random element.
+*(*)*: Returns the random element.
#### Example
```js
<!-- div -->
-### <a id="_samplesizecollection-n0"></a>`_.sampleSize(collection, [n=0])`
-<a href="#_samplesizecollection-n0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8203 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.samplesize "See the npm package")
+### <a id="_samplesizecollection-n1"></a>`_.sampleSize(collection, [n=1])`
+<a href="#_samplesizecollection-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8956 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.samplesize "See the npm package")
Gets `n` random elements at unique keys from `collection` up to the
size of `collection`.
+#### Since
+4.0.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to sample.
-2. `[n=0]` *(number)*: The number of elements to sample.
+2. `[n=1]` *(number)*: The number of elements to sample.
#### Returns
-*(Array)*: Returns the random elements.
+*(Array)*: Returns the random elements.
#### Example
```js
<!-- div -->
### <a id="_shufflecollection"></a>`_.shuffle(collection)`
-<a href="#_shufflecollection">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8235 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.shuffle "See the npm package")
+<a href="#_shufflecollection">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8993 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.shuffle "See the npm package")
Creates an array of shuffled values, using a version of the
[Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to shuffle.
#### Returns
-*(Array)*: Returns the new shuffled array.
+*(Array)*: Returns the new shuffled array.
#### Example
```js
<!-- div -->
### <a id="_sizecollection"></a>`_.size(collection)`
-<a href="#_sizecollection">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8259 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.size "See the npm package")
+<a href="#_sizecollection">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9018 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.size "See the npm package")
Gets the size of `collection` by returning its length for array-like
-values or the number of own enumerable properties for objects.
+values or the number of own enumerable string keyed properties for objects.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to inspect.
#### Returns
-*(number)*: Returns the collection size.
+*(number)*: Returns the collection size.
#### Example
```js
<!-- div -->
### <a id="_somecollection-predicate_identity"></a>`_.some(collection, [predicate=_.identity])`
-<a href="#_somecollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8304 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.some "See the npm package")
+<a href="#_somecollection-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9072 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.some "See the npm package")
Checks if `predicate` returns truthy for **any** element of `collection`.
Iteration is stopped once `predicate` returns truthy. The predicate is
-invoked with three arguments: (value, index|key, collection).
+invoked with three arguments: *(value, index|key, collection)*.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(boolean)*: Returns `true` if any element passes the predicate check, else `false`.
+*(boolean)*: Returns `true` if any element passes the predicate check, else `false`.
#### Example
```js
<!-- div -->
-### <a id="_sortbycollection-iteratees-_identity"></a>`_.sortBy(collection, [iteratees=[_.identity]])`
-<a href="#_sortbycollection-iteratees-_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8345 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortby "See the npm package")
+### <a id="_sortbycollection-iteratees_identity"></a>`_.sortBy(collection, [iteratees=[_.identity]])`
+<a href="#_sortbycollection-iteratees_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9114 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sortby "See the npm package")
Creates an array of elements, sorted in ascending order by the results of
-running each element in a collection through each iteratee. This method
+running each element in a collection thru each iteratee. This method
performs a stable sort, that is, it preserves the original sort order of
-equal elements. The iteratees are invoked with one argument: (value).
+equal elements. The iteratees are invoked with one argument: *(value)*.
+#### Since
+0.1.0
#### Arguments
1. `collection` *(Array|Object)*: The collection to iterate over.
-2. `[iteratees=[_.identity]]` *(...(Function|Function[]|Object|Object[]|string|string[])*: The iteratees to sort by, specified individually or in arrays.
+2. `[iteratees=[_.identity]]` *(...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[]))*: The iteratees to sort by.
#### Returns
-*(Array)*: Returns the new sorted array.
+*(Array)*: Returns the new sorted array.
#### Example
```js
var users = [
{ 'user': 'fred', 'age': 48 },
{ 'user': 'barney', 'age': 36 },
- { 'user': 'fred', 'age': 42 },
+ { 'user': 'fred', 'age': 40 },
{ 'user': 'barney', 'age': 34 }
];
_.sortBy(users, function(o) { return o.user; });
-// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
+// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]]
_.sortBy(users, ['user', 'age']);
-// => objects for [['barney', 34], ['barney', 36], ['fred', 42], ['fred', 48]]
+// => objects for [['barney', 34], ['barney', 36], ['fred', 40], ['fred', 48]]
_.sortBy(users, 'user', function(o) {
return Math.floor(o.age / 10);
});
-// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
+// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]]
```
* * *
<!-- div -->
### <a id="_now"></a>`_.now()`
-<a href="#_now">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8376 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.now "See the npm package")
+<a href="#_now">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9150 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.now "See the npm package")
-({Function}): Gets the timestamp of the number of milliseconds that have elapsed since
-the Unix epoch (1 January 1970 00:00:00 UTC).
+Gets the timestamp of the number of milliseconds that have elapsed since
+the Unix epoch *(1 January `1970 00`:00:00 UTC)*.
+#### Since
+2.4.0
#### Returns
-*(number)*: Returns the timestamp.
+*(number)*: Returns the timestamp.
#### Example
```js
_.defer(function(stamp) {
console.log(_.now() - stamp);
}, _.now());
-// => logs the number of milliseconds it took for the deferred function to be invoked
+// => Logs the number of milliseconds it took for the deferred function to be invoked.
```
* * *
<!-- div -->
### <a id="_aftern-func"></a>`_.after(n, func)`
-<a href="#_aftern-func">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8403 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.after "See the npm package")
+<a href="#_aftern-func">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9178 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.after "See the npm package")
The opposite of `_.before`; this method creates a function that invokes
`func` once it's called `n` or more times.
+#### Since
+0.1.0
#### Arguments
1. `n` *(number)*: The number of calls before `func` is invoked.
2. `func` *(Function)*: The function to restrict.
#### Returns
-*(Function)*: Returns the new restricted function.
+*(Function)*: Returns the new restricted function.
#### Example
```js
_.forEach(saves, function(type) {
asyncSave({ 'type': type, 'complete': done });
});
-// => logs 'done saving!' after the two async saves have completed
+// => Logs 'done saving!' after the two async saves have completed.
```
* * *
<!-- div -->
### <a id="_aryfunc-nfunclength"></a>`_.ary(func, [n=func.length])`
-<a href="#_aryfunc-nfunclength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8431 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ary "See the npm package")
+<a href="#_aryfunc-nfunclength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9207 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ary "See the npm package")
-Creates a function that accepts up to `n` arguments, ignoring any
-additional arguments.
+Creates a function that invokes `func`, with up to `n` arguments,
+ignoring any additional arguments.
+#### Since
+3.0.0
#### Arguments
1. `func` *(Function)*: The function to cap arguments for.
2. `[n=func.length]` *(number)*: The arity cap.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_beforen-func"></a>`_.before(n, func)`
-<a href="#_beforen-func">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8453 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.before "See the npm package")
+<a href="#_beforen-func">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9230 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.before "See the npm package")
Creates a function that invokes `func`, with the `this` binding and arguments
of the created function, while it's called less than `n` times. Subsequent
calls to the created function return the result of the last `func` invocation.
+#### Since
+3.0.0
#### Arguments
1. `n` *(number)*: The number of calls at which `func` is no longer invoked.
2. `func` *(Function)*: The function to restrict.
#### Returns
-*(Function)*: Returns the new restricted function.
+*(Function)*: Returns the new restricted function.
#### Example
```js
<!-- div -->
### <a id="_bindfunc-thisarg-partials"></a>`_.bind(func, thisArg, [partials])`
-<a href="#_bindfunc-thisarg-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8505 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.bind "See the npm package")
+<a href="#_bindfunc-thisarg-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9282 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.bind "See the npm package")
Creates a function that invokes `func` with the `this` binding of `thisArg`
-and prepends any additional `_.bind` arguments to those provided to the
-bound function.
+and `partials` prepended to the arguments it receives.
<br>
<br>
The `_.bind.placeholder` value, which defaults to `_` in monolithic builds,
**Note:** Unlike native `Function#bind` this method doesn't set the "length"
property of bound functions.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to bind.
2. `thisArg` *(*)*: The `this` binding of `func`.
3. `[partials]` *(...*)*: The arguments to be partially applied.
#### Returns
-*(Function)*: Returns the new bound function.
+*(Function)*: Returns the new bound function.
#### Example
```js
<!-- div -->
### <a id="_bindkeyobject-key-partials"></a>`_.bindKey(object, key, [partials])`
-<a href="#_bindkeyobject-key-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8558 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.bindkey "See the npm package")
+<a href="#_bindkeyobject-key-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9336 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.bindkey "See the npm package")
-Creates a function that invokes the method at `object[key]` and prepends
-any additional `_.bindKey` arguments to those provided to the bound function.
+Creates a function that invokes the method at `object[key]` with `partials`
+prepended to the arguments it receives.
<br>
<br>
This method differs from `_.bind` by allowing bound functions to reference
-methods that may be redefined or don't yet exist.
-See [Peter Michaux's article](http://peter.michaux.ca/articles/lazy-function-definition-pattern)
+methods that may be redefined or don't yet exist. See
+[Peter Michaux's article](http://peter.michaux.ca/articles/lazy-function-definition-pattern)
for more details.
<br>
<br>
The `_.bindKey.placeholder` value, which defaults to `_` in monolithic
builds, may be used as a placeholder for partially applied arguments.
+#### Since
+0.10.0
#### Arguments
1. `object` *(Object)*: The object to invoke the method on.
2. `key` *(string)*: The key of the method.
3. `[partials]` *(...*)*: The arguments to be partially applied.
#### Returns
-*(Function)*: Returns the new bound function.
+*(Function)*: Returns the new bound function.
#### Example
```js
<!-- div -->
### <a id="_curryfunc-arityfunclength"></a>`_.curry(func, [arity=func.length])`
-<a href="#_curryfunc-arityfunclength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8607 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.curry "See the npm package")
+<a href="#_curryfunc-arityfunclength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9386 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.curry "See the npm package")
Creates a function that accepts arguments of `func` and either invokes
`func` returning its result, if at least `arity` number of arguments have
<br>
**Note:** This method doesn't set the "length" property of curried functions.
+#### Since
+2.0.0
#### Arguments
1. `func` *(Function)*: The function to curry.
2. `[arity=func.length]` *(number)*: The arity of `func`.
#### Returns
-*(Function)*: Returns the new curried function.
+*(Function)*: Returns the new curried function.
#### Example
```js
<!-- div -->
### <a id="_curryrightfunc-arityfunclength"></a>`_.curryRight(func, [arity=func.length])`
-<a href="#_curryrightfunc-arityfunclength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8651 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.curryright "See the npm package")
+<a href="#_curryrightfunc-arityfunclength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9431 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.curryright "See the npm package")
This method is like `_.curry` except that arguments are applied to `func`
in the manner of `_.partialRight` instead of `_.partial`.
<br>
**Note:** This method doesn't set the "length" property of curried functions.
+#### Since
+3.0.0
#### Arguments
1. `func` *(Function)*: The function to curry.
2. `[arity=func.length]` *(number)*: The arity of `func`.
#### Returns
-*(Function)*: Returns the new curried function.
+*(Function)*: Returns the new curried function.
#### Example
```js
<!-- div -->
-### <a id="_debouncefunc-wait0-options"></a>`_.debounce(func, [wait=0], [options])`
-<a href="#_debouncefunc-wait0-options">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8707 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.debounce "See the npm package")
+### <a id="_debouncefunc-wait0-options-optionsleadingfalse-optionsmaxwait-optionstrailingtrue"></a>`_.debounce(func, [wait=0], [options={}], [options.leading=false], [options.maxWait], [options.trailing=true])`
+<a href="#_debouncefunc-wait0-options-optionsleadingfalse-optionsmaxwait-optionstrailingtrue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9488 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.debounce "See the npm package")
Creates a debounced function that delays invoking `func` until after `wait`
milliseconds have elapsed since the last time the debounced function was
invoked more than once during the `wait` timeout.
<br>
<br>
-See [David Corbacho's article](http://drupalmotion.com/article/debounce-and-throttle-visual-explanation)
+See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)
for details over the differences between `_.debounce` and `_.throttle`.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to debounce.
2. `[wait=0]` *(number)*: The number of milliseconds to delay.
-3. `[options]` *(Object)*: The options object.
+3. `[options={}]` *(Object)*: The options object.
4. `[options.leading=false]` *(boolean)*: Specify invoking on the leading edge of the timeout.
5. `[options.maxWait]` *(number)*: The maximum time `func` is allowed to be delayed before it's invoked.
6. `[options.trailing=true]` *(boolean)*: Specify invoking on the trailing edge of the timeout.
#### Returns
-*(Function)*: Returns the new debounced function.
+*(Function)*: Returns the new debounced function.
#### Example
```js
<!-- div -->
### <a id="_deferfunc-args"></a>`_.defer(func, [args])`
-<a href="#_deferfunc-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8841 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.defer "See the npm package")
+<a href="#_deferfunc-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9630 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.defer "See the npm package")
Defers invoking the `func` until the current call stack has cleared. Any
additional arguments are provided to `func` when it's invoked.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to defer.
2. `[args]` *(...*)*: The arguments to invoke `func` with.
#### Returns
-*(number)*: Returns the timer id.
+*(number)*: Returns the timer id.
#### Example
```js
_.defer(function(text) {
console.log(text);
}, 'deferred');
-// => logs 'deferred' after one or more milliseconds
+// => Logs 'deferred' after one or more milliseconds.
```
* * *
<!-- div -->
### <a id="_delayfunc-wait-args"></a>`_.delay(func, wait, [args])`
-<a href="#_delayfunc-wait-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8863 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.delay "See the npm package")
+<a href="#_delayfunc-wait-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9653 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.delay "See the npm package")
Invokes `func` after `wait` milliseconds. Any additional arguments are
provided to `func` when it's invoked.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to delay.
2. `wait` *(number)*: The number of milliseconds to delay invocation.
3. `[args]` *(...*)*: The arguments to invoke `func` with.
#### Returns
-*(number)*: Returns the timer id.
+*(number)*: Returns the timer id.
#### Example
```js
_.delay(function(text) {
console.log(text);
}, 1000, 'later');
-// => logs 'later' after one second
+// => Logs 'later' after one second.
```
* * *
<!-- div -->
### <a id="_flipfunc"></a>`_.flip(func)`
-<a href="#_flipfunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8884 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flip "See the npm package")
+<a href="#_flipfunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9675 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flip "See the npm package")
Creates a function that invokes `func` with arguments reversed.
+#### Since
+4.0.0
#### Arguments
1. `func` *(Function)*: The function to flip arguments for.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_memoizefunc-resolver"></a>`_.memoize(func, [resolver])`
-<a href="#_memoizefunc-resolver">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8930 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.memoize "See the npm package")
+<a href="#_memoizefunc-resolver">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9723 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.memoize "See the npm package")
Creates a function that memoizes the result of `func`. If `resolver` is
-provided it determines the cache key for storing the result based on the
+provided, it determines the cache key for storing the result based on the
arguments provided to the memoized function. By default, the first argument
provided to the memoized function is used as the map cache key. The `func`
is invoked with the `this` binding of the memoized function.
<br>
**Note:** The cache is exposed as the `cache` property on the memoized
function. Its creation may be customized by replacing the `_.memoize.Cache`
-constructor with one whose instances implement the [`Map`](http://ecma-international.org/ecma-262/6.0/#sec-properties-of-the-map-prototype-object)
+constructor with one whose instances implement the
+[`Map`](http://ecma-international.org/ecma-262/6.0/#sec-properties-of-the-map-prototype-object)
method interface of `delete`, `get`, `has`, and `set`.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to have its output memoized.
2. `[resolver]` *(Function)*: The function to resolve the cache key.
#### Returns
-*(Function)*: Returns the new memoizing function.
+*(Function)*: Returns the new memoizing function.
#### Example
```js
<!-- div -->
### <a id="_negatepredicate"></a>`_.negate(predicate)`
-<a href="#_negatepredicate">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8969 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.negate "See the npm package")
+<a href="#_negatepredicate">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9766 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.negate "See the npm package")
Creates a function that negates the result of the predicate `func`. The
`func` predicate is invoked with the `this` binding and arguments of the
created function.
+#### Since
+3.0.0
#### Arguments
1. `predicate` *(Function)*: The predicate to negate.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_oncefunc"></a>`_.once(func)`
-<a href="#_oncefunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L8995 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.once "See the npm package")
+<a href="#_oncefunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9793 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.once "See the npm package")
Creates a function that is restricted to invoking `func` once. Repeat calls
to the function return the value of the first invocation. The `func` is
invoked with the `this` binding and arguments of the created function.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to restrict.
#### Returns
-*(Function)*: Returns the new restricted function.
+*(Function)*: Returns the new restricted function.
#### Example
```js
<!-- div -->
-### <a id="_overargsfunc-transforms"></a>`_.overArgs(func, [transforms])`
-<a href="#_overargsfunc-transforms">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9030 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.overargs "See the npm package")
+### <a id="_overargsfunc"></a>`_.overArgs(func)`
+<a href="#_overargsfunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9829 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.overargs "See the npm package")
Creates a function that invokes `func` with arguments transformed by
corresponding `transforms`.
+#### Since
+4.0.0
#### Arguments
1. `func` *(Function)*: The function to wrap.
-2. `[transforms]` *(...(Function|Function[])*: The functions to transform arguments, specified individually or in arrays.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_partialfunc-partials"></a>`_.partial(func, [partials])`
-<a href="#_partialfunc-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9077 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.partial "See the npm package")
+<a href="#_partialfunc-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9879 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.partial "See the npm package")
-Creates a function that invokes `func` with `partial` arguments prepended
-to those provided to the new function. This method is like `_.bind` except
-it does **not** alter the `this` binding.
+Creates a function that invokes `func` with `partials` prepended to the
+arguments it receives. This method is like `_.bind` except it does **not**
+alter the `this` binding.
<br>
<br>
The `_.partial.placeholder` value, which defaults to `_` in monolithic
**Note:** This method doesn't set the "length" property of partially
applied functions.
+#### Since
+0.2.0
#### Arguments
1. `func` *(Function)*: The function to partially apply arguments to.
2. `[partials]` *(...*)*: The arguments to be partially applied.
#### Returns
-*(Function)*: Returns the new partially applied function.
+*(Function)*: Returns the new partially applied function.
#### Example
```js
<!-- div -->
### <a id="_partialrightfunc-partials"></a>`_.partialRight(func, [partials])`
-<a href="#_partialrightfunc-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9113 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.partialright "See the npm package")
+<a href="#_partialrightfunc-partials">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9916 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.partialright "See the npm package")
This method is like `_.partial` except that partially applied arguments
-are appended to those provided to the new function.
+are appended to the arguments it receives.
<br>
<br>
The `_.partialRight.placeholder` value, which defaults to `_` in monolithic
**Note:** This method doesn't set the "length" property of partially
applied functions.
+#### Since
+1.0.0
#### Arguments
1. `func` *(Function)*: The function to partially apply arguments to.
2. `[partials]` *(...*)*: The arguments to be partially applied.
#### Returns
-*(Function)*: Returns the new partially applied function.
+*(Function)*: Returns the new partially applied function.
#### Example
```js
<!-- div -->
### <a id="_reargfunc-indexes"></a>`_.rearg(func, indexes)`
-<a href="#_reargfunc-indexes">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9140 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.rearg "See the npm package")
+<a href="#_reargfunc-indexes">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9943 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.rearg "See the npm package")
Creates a function that invokes `func` with arguments arranged according
-to the specified indexes where the argument value at the first index is
+to the specified `indexes` where the argument value at the first index is
provided as the first argument, the argument value at the second index is
provided as the second argument, and so on.
+#### Since
+3.0.0
#### Arguments
1. `func` *(Function)*: The function to rearrange arguments for.
-2. `indexes` *(...(number|number[])*: The arranged argument indexes, specified individually or in arrays.
+2. `indexes` *(...(number|number[]))*: The arranged argument indexes.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_restfunc-startfunclength-1"></a>`_.rest(func, [start=func.length-1])`
-<a href="#_restfunc-startfunclength-1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9166 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.rest "See the npm package")
+<a href="#_restfunc-startfunclength-1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L9972 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.rest "See the npm package")
Creates a function that invokes `func` with the `this` binding of the
-created function and arguments from `start` and beyond provided as an array.
+created function and arguments from `start` and beyond provided as
+an array.
<br>
<br>
-**Note:** This method is based on the [rest parameter](https://mdn.io/rest_parameters).
+**Note:** This method is based on the
+[rest parameter](https://mdn.io/rest_parameters).
+#### Since
+4.0.0
#### Arguments
1. `func` *(Function)*: The function to apply a rest parameter to.
2. `[start=func.length-1]` *(number)*: The start position of the rest parameter.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_spreadfunc-start0"></a>`_.spread(func, [start=0])`
-<a href="#_spreadfunc-start0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9226 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.spread "See the npm package")
+<a href="#_spreadfunc-start0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10035 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.spread "See the npm package")
-Creates a function that invokes `func` with the `this` binding of the created
-function and an array of arguments much like [`Function#apply`](https://es5.github.io/#x15.3.4.3).
+Creates a function that invokes `func` with the `this` binding of the
+create function and an array of arguments much like
+[`Function#apply`](http://www.ecma-international.org/ecma-262/6.0/#sec-function.prototype.apply).
<br>
<br>
-**Note:** This method is based on the [spread operator](https://mdn.io/spread_operator).
+**Note:** This method is based on the
+[spread operator](https://mdn.io/spread_operator).
+#### Since
+3.2.0
#### Arguments
1. `func` *(Function)*: The function to spread arguments over.
2. `[start=0]` *(number)*: The start position of the spread.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
-### <a id="_throttlefunc-wait0-options"></a>`_.throttle(func, [wait=0], [options])`
-<a href="#_throttlefunc-wait0-options">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9282 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.throttle "See the npm package")
+### <a id="_throttlefunc-wait0-options-optionsleadingtrue-optionstrailingtrue"></a>`_.throttle(func, [wait=0], [options={}], [options.leading=true], [options.trailing=true])`
+<a href="#_throttlefunc-wait0-options-optionsleadingtrue-optionstrailingtrue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10092 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.throttle "See the npm package")
Creates a throttled function that only invokes `func` at most once per
every `wait` milliseconds. The throttled function comes with a `cancel`
result of the last `func` invocation.
<br>
<br>
-**Note:** If `leading` and `trailing` options are `true`, `func` is invoked
-on the trailing edge of the timeout only if the throttled function is
-invoked more than once during the `wait` timeout.
+**Note:** If `leading` and `trailing` options are `true`, `func` is
+invoked on the trailing edge of the timeout only if the throttled function
+is invoked more than once during the `wait` timeout.
<br>
<br>
-See [David Corbacho's article](http://drupalmotion.com/article/debounce-and-throttle-visual-explanation)
+See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/)
for details over the differences between `_.throttle` and `_.debounce`.
+#### Since
+0.1.0
#### Arguments
1. `func` *(Function)*: The function to throttle.
2. `[wait=0]` *(number)*: The number of milliseconds to throttle invocations to.
-3. `[options]` *(Object)*: The options object.
+3. `[options={}]` *(Object)*: The options object.
4. `[options.leading=true]` *(boolean)*: Specify invoking on the leading edge of the timeout.
5. `[options.trailing=true]` *(boolean)*: Specify invoking on the trailing edge of the timeout.
#### Returns
-*(Function)*: Returns the new throttled function.
+*(Function)*: Returns the new throttled function.
#### Example
```js
<!-- div -->
### <a id="_unaryfunc"></a>`_.unary(func)`
-<a href="#_unaryfunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9314 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unary "See the npm package")
+<a href="#_unaryfunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10125 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unary "See the npm package")
Creates a function that accepts up to one argument, ignoring any
additional arguments.
+#### Since
+4.0.0
#### Arguments
1. `func` *(Function)*: The function to cap arguments for.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_wrapvalue-wrapperidentity"></a>`_.wrap(value, [wrapper=identity])`
-<a href="#_wrapvalue-wrapperidentity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9339 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.wrap "See the npm package")
+<a href="#_wrapvalue-wrapperidentity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10151 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.wrap "See the npm package")
Creates a function that provides `value` to the wrapper function as its
first argument. Any additional arguments provided to the function are
appended to those provided to the wrapper function. The wrapper is invoked
with the `this` binding of the created function.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to wrap.
2. `[wrapper=identity]` *(Function)*: The wrapper function.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_castarrayvalue"></a>`_.castArray(value)`
-<a href="#_castarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9378 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.castarray "See the npm package")
+<a href="#_castarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10191 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.castarray "See the npm package")
Casts `value` as an array if it's not one.
+#### Since
+4.4.0
#### Arguments
1. `value` *(*)*: The value to inspect.
#### Returns
-*(Array)*: Returns the cast array.
+*(Array)*: Returns the cast array.
#### Example
```js
<!-- div -->
### <a id="_clonevalue"></a>`_.clone(value)`
-<a href="#_clonevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9410 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clone "See the npm package")
+<a href="#_clonevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10225 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clone "See the npm package")
Creates a shallow clone of `value`.
<br>
as plain objects. An empty object is returned for uncloneable values such
as error objects, functions, DOM nodes, and WeakMaps.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to clone.
#### Returns
-*(*)*: Returns the cloned value.
+*(*)*: Returns the cloned value.
#### Example
```js
<!-- div -->
### <a id="_clonedeepvalue"></a>`_.cloneDeep(value)`
-<a href="#_clonedeepvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9463 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clonedeep "See the npm package")
+<a href="#_clonedeepvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10282 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clonedeep "See the npm package")
This method is like `_.clone` except that it recursively clones `value`.
+#### Since
+1.0.0
#### Arguments
1. `value` *(*)*: The value to recursively clone.
#### Returns
-*(*)*: Returns the deep cloned value.
+*(*)*: Returns the deep cloned value.
#### Example
```js
<!-- div -->
### <a id="_clonedeepwithvalue-customizer"></a>`_.cloneDeepWith(value, [customizer])`
-<a href="#_clonedeepwithvalue-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9493 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clonedeepwith "See the npm package")
+<a href="#_clonedeepwithvalue-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10314 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clonedeepwith "See the npm package")
This method is like `_.cloneWith` except that it recursively clones `value`.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to recursively clone.
2. `[customizer]` *(Function)*: The function to customize cloning.
#### Returns
-*(*)*: Returns the deep cloned value.
+*(*)*: Returns the deep cloned value.
#### Example
```js
<!-- div -->
### <a id="_clonewithvalue-customizer"></a>`_.cloneWith(value, [customizer])`
-<a href="#_clonewithvalue-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9443 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clonewith "See the npm package")
+<a href="#_clonewithvalue-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10260 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clonewith "See the npm package")
This method is like `_.clone` except that it accepts `customizer` which
-is invoked to produce the cloned value. If `customizer` returns `undefined`
+is invoked to produce the cloned value. If `customizer` returns `undefined`,
cloning is handled by the method instead. The `customizer` is invoked with
-up to four arguments; (value [, index|key, object, stack]).
+up to four arguments; *(value [, index|key, object, stack])*.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to clone.
2. `[customizer]` *(Function)*: The function to customize cloning.
#### Returns
-*(*)*: Returns the cloned value.
+*(*)*: Returns the cloned value.
#### Example
```js
<!-- div -->
### <a id="_eqvalue-other"></a>`_.eq(value, other)`
-<a href="#_eqvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9527 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.eq "See the npm package")
+<a href="#_eqvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10350 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.eq "See the npm package")
-Performs a [`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
+Performs a
+[`SameValueZero`](http://ecma-international.org/ecma-262/6.0/#sec-samevaluezero)
comparison between two values to determine if they are equivalent.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
#### Returns
-*(boolean)*: Returns `true` if the values are equivalent, else `false`.
+*(boolean)*: Returns `true` if the values are equivalent, else `false`.
#### Example
```js
<!-- div -->
### <a id="_gtvalue-other"></a>`_.gt(value, other)`
-<a href="#_gtvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9551 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.gt "See the npm package")
+<a href="#_gtvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10377 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.gt "See the npm package")
Checks if `value` is greater than `other`.
+#### Since
+3.9.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
#### Returns
-*(boolean)*: Returns `true` if `value` is greater than `other`, else `false`.
+*(boolean)*: Returns `true` if `value` is greater than `other`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_gtevalue-other"></a>`_.gte(value, other)`
-<a href="#_gtevalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9575 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.gte "See the npm package")
+<a href="#_gtevalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10402 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.gte "See the npm package")
Checks if `value` is greater than or equal to `other`.
+#### Since
+3.9.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
#### Returns
-*(boolean)*: Returns `true` if `value` is greater than or equal to `other`, else `false`.
+*(boolean)*: Returns `true` if `value` is greater than or equal to `other`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isargumentsvalue"></a>`_.isArguments(value)`
-<a href="#_isargumentsvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9595 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarguments "See the npm package")
+<a href="#_isargumentsvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10424 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarguments "See the npm package")
Checks if `value` is likely an `arguments` object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isarrayvalue"></a>`_.isArray(value)`
-<a href="#_isarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9624 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarray "See the npm package")
+<a href="#_isarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10455 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarray "See the npm package")
-({Function}): Checks if `value` is classified as an `Array` object.
+Checks if `value` is classified as an `Array` object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isarraybuffervalue"></a>`_.isArrayBuffer(value)`
-<a href="#_isarraybuffervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9642 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarraybuffer "See the npm package")
+<a href="#_isarraybuffervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10475 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarraybuffer "See the npm package")
Checks if `value` is classified as an `ArrayBuffer` object.
+#### Since
+4.3.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isarraylikevalue"></a>`_.isArrayLike(value)`
-<a href="#_isarraylikevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9670 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarraylike "See the npm package")
+<a href="#_isarraylikevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10504 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarraylike "See the npm package")
Checks if `value` is array-like. A value is considered array-like if it's
not a function and has a `value.length` that's an integer greater than or
equal to `0` and less than or equal to `Number.MAX_SAFE_INTEGER`.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is array-like, else `false`.
+*(boolean)*: Returns `true` if `value` is array-like, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isarraylikeobjectvalue"></a>`_.isArrayLikeObject(value)`
-<a href="#_isarraylikeobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9698 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarraylikeobject "See the npm package")
+<a href="#_isarraylikeobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10533 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isarraylikeobject "See the npm package")
This method is like `_.isArrayLike` except that it also checks if `value`
is an object.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is an array-like object, else `false`.
+*(boolean)*: Returns `true` if `value` is an array-like object, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isbooleanvalue"></a>`_.isBoolean(value)`
-<a href="#_isbooleanvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9718 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isboolean "See the npm package")
+<a href="#_isbooleanvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10555 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isboolean "See the npm package")
Checks if `value` is classified as a boolean primitive or object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isbuffervalue"></a>`_.isBuffer(value)`
-<a href="#_isbuffervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9739 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isbuffer "See the npm package")
+<a href="#_isbuffervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10577 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isbuffer "See the npm package")
Checks if `value` is a buffer.
+#### Since
+4.3.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a buffer, else `false`.
+*(boolean)*: Returns `true` if `value` is a buffer, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isdatevalue"></a>`_.isDate(value)`
-<a href="#_isdatevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9759 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isdate "See the npm package")
+<a href="#_isdatevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10599 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isdate "See the npm package")
Checks if `value` is classified as a `Date` object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_iselementvalue"></a>`_.isElement(value)`
-<a href="#_iselementvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9779 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.iselement "See the npm package")
+<a href="#_iselementvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10621 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.iselement "See the npm package")
Checks if `value` is likely a DOM element.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a DOM element, else `false`.
+*(boolean)*: Returns `true` if `value` is a DOM element, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isemptyvalue"></a>`_.isEmpty(value)`
-<a href="#_isemptyvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9810 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isempty "See the npm package")
+<a href="#_isemptyvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10658 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isempty "See the npm package")
-Checks if `value` is empty. A value is considered empty unless it's an
-`arguments` object, array, string, or jQuery-like collection with a length
-greater than `0` or an object with own enumerable properties.
+Checks if `value` is an empty object, collection, map, or set.
+<br>
+<br>
+Objects are considered empty if they have no own enumerable string keyed
+properties.
+<br>
+<br>
+Array-like values such as `arguments` objects, arrays, buffers, strings, or
+jQuery-like collections are considered empty if they have a `length` of `0`.
+Similarly, maps and sets are considered empty if they have a `size` of `0`.
+#### Since
+0.1.0
#### Arguments
-1. `value` *(Array|Object|string)*: The value to inspect.
+1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is empty, else `false`.
+*(boolean)*: Returns `true` if `value` is empty, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isequalvalue-other"></a>`_.isEqual(value, other)`
-<a href="#_isequalvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9851 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isequal "See the npm package")
+<a href="#_isequalvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10707 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isequal "See the npm package")
Performs a deep comparison between two values to determine if they are
equivalent.
by their own, not inherited, enumerable properties. Functions and DOM
nodes are **not** supported.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
#### Returns
-*(boolean)*: Returns `true` if the values are equivalent, else `false`.
+*(boolean)*: Returns `true` if the values are equivalent, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isequalwithvalue-other-customizer"></a>`_.isEqualWith(value, other, [customizer])`
-<a href="#_isequalwithvalue-other-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9886 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isequalwith "See the npm package")
+<a href="#_isequalwithvalue-other-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10744 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isequalwith "See the npm package")
This method is like `_.isEqual` except that it accepts `customizer` which
-is invoked to compare values. If `customizer` returns `undefined` comparisons
+is invoked to compare values. If `customizer` returns `undefined`, comparisons
are handled by the method instead. The `customizer` is invoked with up to
-six arguments: (objValue, othValue [, index|key, object, other, stack]).
+six arguments: *(objValue, othValue [, index|key, object, other, stack])*.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
3. `[customizer]` *(Function)*: The function to customize comparisons.
#### Returns
-*(boolean)*: Returns `true` if the values are equivalent, else `false`.
+*(boolean)*: Returns `true` if the values are equivalent, else `false`.
#### Example
```js
<!-- div -->
### <a id="_iserrorvalue"></a>`_.isError(value)`
-<a href="#_iserrorvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9909 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.iserror "See the npm package")
+<a href="#_iserrorvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10769 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.iserror "See the npm package")
Checks if `value` is an `Error`, `EvalError`, `RangeError`, `ReferenceError`,
`SyntaxError`, `TypeError`, or `URIError` object.
+#### Since
+3.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is an error object, else `false`.
+*(boolean)*: Returns `true` if `value` is an error object, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isfinitevalue"></a>`_.isFinite(value)`
-<a href="#_isfinitevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9941 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isfinite "See the npm package")
+<a href="#_isfinitevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10804 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isfinite "See the npm package")
Checks if `value` is a finite primitive number.
<br>
<br>
-**Note:** This method is based on [`Number.isFinite`](https://mdn.io/Number/isFinite).
+**Note:** This method is based on
+[`Number.isFinite`](https://mdn.io/Number/isFinite).
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a finite number, else `false`.
+*(boolean)*: Returns `true` if `value` is a finite number, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isfunctionvalue"></a>`_.isFunction(value)`
-<a href="#_isfunctionvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9961 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isfunction "See the npm package")
+<a href="#_isfunctionvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10826 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isfunction "See the npm package")
Checks if `value` is classified as a `Function` object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isintegervalue"></a>`_.isInteger(value)`
-<a href="#_isintegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L9993 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isinteger "See the npm package")
+<a href="#_isintegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10860 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isinteger "See the npm package")
Checks if `value` is an integer.
<br>
<br>
-**Note:** This method is based on [`Number.isInteger`](https://mdn.io/Number/isInteger).
+**Note:** This method is based on
+[`Number.isInteger`](https://mdn.io/Number/isInteger).
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is an integer, else `false`.
+*(boolean)*: Returns `true` if `value` is an integer, else `false`.
#### Example
```js
<!-- div -->
### <a id="_islengthvalue"></a>`_.isLength(value)`
-<a href="#_islengthvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10021 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.islength "See the npm package")
+<a href="#_islengthvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10891 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.islength "See the npm package")
Checks if `value` is a valid array-like length.
<br>
<br>
-**Note:** This function is loosely based on [`ToLength`](http://ecma-international.org/ecma-262/6.0/#sec-tolength).
+**Note:** This function is loosely based on
+[`ToLength`](http://ecma-international.org/ecma-262/6.0/#sec-tolength).
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a valid length, else `false`.
+*(boolean)*: Returns `true` if `value` is a valid length, else `false`.
#### Example
```js
<!-- div -->
### <a id="_ismapvalue"></a>`_.isMap(value)`
-<a href="#_ismapvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10097 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ismap "See the npm package")
+<a href="#_ismapvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10972 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ismap "See the npm package")
Checks if `value` is classified as a `Map` object.
+#### Since
+4.3.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_ismatchobject-source"></a>`_.isMatch(object, source)`
-<a href="#_ismatchobject-source">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10124 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ismatch "See the npm package")
+<a href="#_ismatchobject-source">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11000 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ismatch "See the npm package")
Performs a partial deep comparison between `object` and `source` to
determine if `object` contains equivalent property values. This method is
<br>
**Note:** This method supports comparing the same values as `_.isEqual`.
+#### Since
+3.0.0
#### Arguments
1. `object` *(Object)*: The object to inspect.
2. `source` *(Object)*: The object of property values to match.
#### Returns
-*(boolean)*: Returns `true` if `object` is a match, else `false`.
+*(boolean)*: Returns `true` if `object` is a match, else `false`.
#### Example
```js
<!-- div -->
### <a id="_ismatchwithobject-source-customizer"></a>`_.isMatchWith(object, source, [customizer])`
-<a href="#_ismatchwithobject-source-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10159 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ismatchwith "See the npm package")
+<a href="#_ismatchwithobject-source-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11036 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ismatchwith "See the npm package")
This method is like `_.isMatch` except that it accepts `customizer` which
-is invoked to compare values. If `customizer` returns `undefined` comparisons
+is invoked to compare values. If `customizer` returns `undefined`, comparisons
are handled by the method instead. The `customizer` is invoked with five
-arguments: (objValue, srcValue, index|key, object, source).
+arguments: *(objValue, srcValue, index|key, object, source)*.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The object to inspect.
2. `source` *(Object)*: The object of property values to match.
3. `[customizer]` *(Function)*: The function to customize comparisons.
#### Returns
-*(boolean)*: Returns `true` if `object` is a match, else `false`.
+*(boolean)*: Returns `true` if `object` is a match, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isnanvalue"></a>`_.isNaN(value)`
-<a href="#_isnanvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10189 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnan "See the npm package")
+<a href="#_isnanvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11069 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnan "See the npm package")
Checks if `value` is `NaN`.
<br>
<br>
-**Note:** This method is not the same as [`isNaN`](https://es5.github.io/#x15.1.2.4)
-which returns `true` for `undefined` and other non-numeric values.
+**Note:** This method is based on
+[`Number.isNaN`](https://mdn.io/Number/isNaN) and is not the same as
+global [`isNaN`](https://mdn.io/isNaN) which returns `true` for
+`undefined` and other non-number values.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is `NaN`, else `false`.
+*(boolean)*: Returns `true` if `value` is `NaN`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isnativevalue"></a>`_.isNative(value)`
-<a href="#_isnativevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10211 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnative "See the npm package")
+<a href="#_isnativevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11094 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnative "See the npm package")
Checks if `value` is a native function.
+#### Since
+3.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a native function, else `false`.
+*(boolean)*: Returns `true` if `value` is a native function, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isnilvalue"></a>`_.isNil(value)`
-<a href="#_isnilvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10261 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnil "See the npm package")
+<a href="#_isnilvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11143 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnil "See the npm package")
Checks if `value` is `null` or `undefined`.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is nullish, else `false`.
+*(boolean)*: Returns `true` if `value` is nullish, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isnullvalue"></a>`_.isNull(value)`
-<a href="#_isnullvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10238 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnull "See the npm package")
+<a href="#_isnullvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11119 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnull "See the npm package")
Checks if `value` is `null`.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is `null`, else `false`.
+*(boolean)*: Returns `true` if `value` is `null`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isnumbervalue"></a>`_.isNumber(value)`
-<a href="#_isnumbervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10290 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnumber "See the npm package")
+<a href="#_isnumbervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11174 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isnumber "See the npm package")
Checks if `value` is classified as a `Number` primitive or object.
<br>
<br>
-**Note:** To exclude `Infinity`, `-Infinity`, and `NaN`, which are classified
-as numbers, use the `_.isFinite` method.
+**Note:** To exclude `Infinity`, `-Infinity`, and `NaN`, which are
+classified as numbers, use the `_.isFinite` method.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isobjectvalue"></a>`_.isObject(value)`
-<a href="#_isobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10049 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isobject "See the npm package")
+<a href="#_isobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10921 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isobject "See the npm package")
-Checks if `value` is the [language type](https://es5.github.io/#x8) of `Object`.
-(e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`)
+Checks if `value` is the
+[language type](http://www.ecma-international.org/ecma-262/6.0/#sec-ecmascript-language-types)
+of `Object`. *(e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`)*
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is an object, else `false`.
+*(boolean)*: Returns `true` if `value` is an object, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isobjectlikevalue"></a>`_.isObjectLike(value)`
-<a href="#_isobjectlikevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10077 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isobjectlike "See the npm package")
+<a href="#_isobjectlikevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L10950 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isobjectlike "See the npm package")
Checks if `value` is object-like. A value is object-like if it's not `null`
and has a `typeof` result of "object".
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is object-like, else `false`.
+*(boolean)*: Returns `true` if `value` is object-like, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isplainobjectvalue"></a>`_.isPlainObject(value)`
-<a href="#_isplainobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10322 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isplainobject "See the npm package")
+<a href="#_isplainobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11208 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isplainobject "See the npm package")
Checks if `value` is a plain object, that is, an object created by the
`Object` constructor or one with a `[[Prototype]]` of `null`.
+#### Since
+0.8.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a plain object, else `false`.
+*(boolean)*: Returns `true` if `value` is a plain object, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isregexpvalue"></a>`_.isRegExp(value)`
-<a href="#_isregexpvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10352 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isregexp "See the npm package")
+<a href="#_isregexpvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11240 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isregexp "See the npm package")
Checks if `value` is classified as a `RegExp` object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_issafeintegervalue"></a>`_.isSafeInteger(value)`
-<a href="#_issafeintegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10381 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.issafeinteger "See the npm package")
+<a href="#_issafeintegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11272 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.issafeinteger "See the npm package")
Checks if `value` is a safe integer. An integer is safe if it's an IEEE-754
double precision number which isn't the result of a rounded unsafe integer.
<br>
<br>
-**Note:** This method is based on [`Number.isSafeInteger`](https://mdn.io/Number/isSafeInteger).
+**Note:** This method is based on
+[`Number.isSafeInteger`](https://mdn.io/Number/isSafeInteger).
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is a safe integer, else `false`.
+*(boolean)*: Returns `true` if `value` is a safe integer, else `false`.
#### Example
```js
<!-- div -->
### <a id="_issetvalue"></a>`_.isSet(value)`
-<a href="#_issetvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10401 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isset "See the npm package")
+<a href="#_issetvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11294 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isset "See the npm package")
Checks if `value` is classified as a `Set` object.
+#### Since
+4.3.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isstringvalue"></a>`_.isString(value)`
-<a href="#_isstringvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10421 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isstring "See the npm package")
+<a href="#_isstringvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11316 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isstring "See the npm package")
Checks if `value` is classified as a `String` primitive or object.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_issymbolvalue"></a>`_.isSymbol(value)`
-<a href="#_issymbolvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10442 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.issymbol "See the npm package")
+<a href="#_issymbolvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11339 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.issymbol "See the npm package")
Checks if `value` is classified as a `Symbol` primitive or object.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_istypedarrayvalue"></a>`_.isTypedArray(value)`
-<a href="#_istypedarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10463 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.istypedarray "See the npm package")
+<a href="#_istypedarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11362 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.istypedarray "See the npm package")
Checks if `value` is classified as a typed array.
+#### Since
+3.0.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isundefinedvalue"></a>`_.isUndefined(value)`
-<a href="#_isundefinedvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10484 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isundefined "See the npm package")
+<a href="#_isundefinedvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11384 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isundefined "See the npm package")
Checks if `value` is `undefined`.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is `undefined`, else `false`.
+*(boolean)*: Returns `true` if `value` is `undefined`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isweakmapvalue"></a>`_.isWeakMap(value)`
-<a href="#_isweakmapvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10504 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isweakmap "See the npm package")
+<a href="#_isweakmapvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11406 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isweakmap "See the npm package")
Checks if `value` is classified as a `WeakMap` object.
+#### Since
+4.3.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_isweaksetvalue"></a>`_.isWeakSet(value)`
-<a href="#_isweaksetvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10524 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isweakset "See the npm package")
+<a href="#_isweaksetvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11428 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.isweakset "See the npm package")
Checks if `value` is classified as a `WeakSet` object.
+#### Since
+4.3.0
#### Arguments
1. `value` *(*)*: The value to check.
#### Returns
-*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
+*(boolean)*: Returns `true` if `value` is correctly classified, else `false`.
#### Example
```js
<!-- div -->
### <a id="_ltvalue-other"></a>`_.lt(value, other)`
-<a href="#_ltvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10548 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lt "See the npm package")
+<a href="#_ltvalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11455 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lt "See the npm package")
Checks if `value` is less than `other`.
+#### Since
+3.9.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
#### Returns
-*(boolean)*: Returns `true` if `value` is less than `other`, else `false`.
+*(boolean)*: Returns `true` if `value` is less than `other`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_ltevalue-other"></a>`_.lte(value, other)`
-<a href="#_ltevalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10572 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lte "See the npm package")
+<a href="#_ltevalue-other">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11480 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lte "See the npm package")
Checks if `value` is less than or equal to `other`.
+#### Since
+3.9.0
#### Arguments
1. `value` *(*)*: The value to compare.
2. `other` *(*)*: The other value to compare.
#### Returns
-*(boolean)*: Returns `true` if `value` is less than or equal to `other`, else `false`.
+*(boolean)*: Returns `true` if `value` is less than or equal to `other`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_toarrayvalue"></a>`_.toArray(value)`
-<a href="#_toarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10598 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.toarray "See the npm package")
+<a href="#_toarrayvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11507 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.toarray "See the npm package")
Converts `value` to an array.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to convert.
#### Returns
-*(Array)*: Returns the converted array.
+*(Array)*: Returns the converted array.
#### Example
```js
<!-- div -->
### <a id="_tointegervalue"></a>`_.toInteger(value)`
-<a href="#_tointegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10638 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tointeger "See the npm package")
+<a href="#_tointegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11549 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tointeger "See the npm package")
Converts `value` to an integer.
<br>
<br>
-**Note:** This function is loosely based on [`ToInteger`](http://www.ecma-international.org/ecma-262/6.0/#sec-tointeger).
+**Note:** This function is loosely based on
+[`ToInteger`](http://www.ecma-international.org/ecma-262/6.0/#sec-tointeger).
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to convert.
#### Returns
-*(number)*: Returns the converted integer.
+*(number)*: Returns the converted integer.
#### Example
```js
<!-- div -->
### <a id="_tolengthvalue"></a>`_.toLength(value)`
-<a href="#_tolengthvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10676 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tolength "See the npm package")
+<a href="#_tolengthvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11589 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tolength "See the npm package")
Converts `value` to an integer suitable for use as the length of an
array-like object.
<br>
<br>
-**Note:** This method is based on [`ToLength`](http://ecma-international.org/ecma-262/6.0/#sec-tolength).
+**Note:** This method is based on
+[`ToLength`](http://ecma-international.org/ecma-262/6.0/#sec-tolength).
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to convert.
#### Returns
-*(number)*: Returns the converted integer.
+*(number)*: Returns the converted integer.
#### Example
```js
<!-- div -->
### <a id="_tonumbervalue"></a>`_.toNumber(value)`
-<a href="#_tonumbervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10702 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tonumber "See the npm package")
+<a href="#_tonumbervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11616 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tonumber "See the npm package")
Converts `value` to a number.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to process.
#### Returns
-*(number)*: Returns the number.
+*(number)*: Returns the number.
#### Example
```js
<!-- div -->
### <a id="_toplainobjectvalue"></a>`_.toPlainObject(value)`
-<a href="#_toplainobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10740 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.toplainobject "See the npm package")
+<a href="#_toplainobjectvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11661 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.toplainobject "See the npm package")
-Converts `value` to a plain object flattening inherited enumerable
-properties of `value` to own properties of the plain object.
+Converts `value` to a plain object flattening inherited enumerable string
+keyed properties of `value` to own properties of the plain object.
+#### Since
+3.0.0
#### Arguments
1. `value` *(*)*: The value to convert.
#### Returns
-*(Object)*: Returns the converted plain object.
+*(Object)*: Returns the converted plain object.
#### Example
```js
<!-- div -->
### <a id="_tosafeintegervalue"></a>`_.toSafeInteger(value)`
-<a href="#_tosafeintegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10767 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tosafeinteger "See the npm package")
+<a href="#_tosafeintegervalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11689 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tosafeinteger "See the npm package")
Converts `value` to a safe integer. A safe integer can be compared and
represented correctly.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to convert.
#### Returns
-*(number)*: Returns the converted integer.
+*(number)*: Returns the converted integer.
#### Example
```js
<!-- div -->
### <a id="_tostringvalue"></a>`_.toString(value)`
-<a href="#_tostringvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10791 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tostring "See the npm package")
+<a href="#_tostringvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11714 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tostring "See the npm package")
-Converts `value` to a string if it's not one. An empty string is returned
-for `null` and `undefined` values. The sign of `-0` is preserved.
+Converts `value` to a string. An empty string is returned for `null`
+and `undefined` values. The sign of `-0` is preserved.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to process.
#### Returns
-*(string)*: Returns the string.
+*(string)*: Returns the string.
#### Example
```js
<!-- div -->
### <a id="_addaugend-addend"></a>`_.add(augend, addend)`
-<a href="#_addaugend-addend">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14054 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.add "See the npm package")
+<a href="#_addaugend-addend">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15229 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.add "See the npm package")
Adds two numbers.
+#### Since
+3.4.0
#### Arguments
1. `augend` *(number)*: The first number in an addition.
2. `addend` *(number)*: The second number in an addition.
#### Returns
-*(number)*: Returns the total.
+*(number)*: Returns the total.
#### Example
```js
<!-- div -->
### <a id="_ceilnumber-precision0"></a>`_.ceil(number, [precision=0])`
-<a href="#_ceilnumber-precision0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14088 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ceil "See the npm package")
+<a href="#_ceilnumber-precision0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15254 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ceil "See the npm package")
Computes `number` rounded up to `precision`.
+#### Since
+3.10.0
#### Arguments
1. `number` *(number)*: The number to round up.
2. `[precision=0]` *(number)*: The precision to round up to.
#### Returns
-*(number)*: Returns the rounded up number.
+*(number)*: Returns the rounded up number.
#### Example
```js
<!-- div -->
+### <a id="_dividedividend-divisor"></a>`_.divide(dividend, divisor)`
+<a href="#_dividedividend-divisor">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15271 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.divide "See the npm package")
+
+Divide two numbers.
+
+#### Since
+4.7.0
+#### Arguments
+1. `dividend` *(number)*: The first number in a division.
+2. `divisor` *(number)*: The second number in a division.
+
+#### Returns
+*(number)*: Returns the quotient.
+
+#### Example
+```js
+_.divide(6, 4);
+// => 1.5
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_floornumber-precision0"></a>`_.floor(number, [precision=0])`
-<a href="#_floornumber-precision0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14110 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.floor "See the npm package")
+<a href="#_floornumber-precision0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15296 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.floor "See the npm package")
Computes `number` rounded down to `precision`.
+#### Since
+3.10.0
#### Arguments
1. `number` *(number)*: The number to round down.
2. `[precision=0]` *(number)*: The precision to round down to.
#### Returns
-*(number)*: Returns the rounded down number.
+*(number)*: Returns the rounded down number.
#### Example
```js
<!-- div -->
### <a id="_maxarray"></a>`_.max(array)`
-<a href="#_maxarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14129 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.max "See the npm package")
+<a href="#_maxarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15316 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.max "See the npm package")
-Computes the maximum value of `array`. If `array` is empty or falsey
+Computes the maximum value of `array`. If `array` is empty or falsey,
`undefined` is returned.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
#### Returns
-*(*)*: Returns the maximum value.
+*(*)*: Returns the maximum value.
#### Example
```js
<!-- div -->
### <a id="_maxbyarray-iteratee_identity"></a>`_.maxBy(array, [iteratee=_.identity])`
-<a href="#_maxbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14157 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.maxby "See the npm package")
+<a href="#_maxbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15346 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.maxby "See the npm package")
This method is like `_.max` except that it accepts `iteratee` which is
invoked for each element in `array` to generate the criterion by which
-the value is ranked. The iteratee is invoked with one argument: (value).
+the value is ranked. The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(*)*: Returns the maximum value.
+*(*)*: Returns the maximum value.
#### Example
```js
<!-- div -->
### <a id="_meanarray"></a>`_.mean(array)`
-<a href="#_meanarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14176 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mean "See the npm package")
+<a href="#_meanarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15366 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mean "See the npm package")
Computes the mean of the values in `array`.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
#### Returns
-*(number)*: Returns the mean.
+*(number)*: Returns the mean.
#### Example
```js
<!-- div -->
+### <a id="_meanbyarray-iteratee_identity"></a>`_.meanBy(array, [iteratee=_.identity])`
+<a href="#_meanbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15394 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.meanby "See the npm package")
+
+This method is like `_.mean` except that it accepts `iteratee` which is
+invoked for each element in `array` to generate the value to be averaged.
+The iteratee is invoked with one argument: *(value)*.
+
+#### Since
+4.7.0
+#### Arguments
+1. `array` *(Array)*: The array to iterate over.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
+
+#### Returns
+*(number)*: Returns the mean.
+
+#### Example
+```js
+var objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];
+
+_.meanBy(objects, function(o) { return o.n; });
+// => 5
+
+// The `_.property` iteratee shorthand.
+_.meanBy(objects, 'n');
+// => 5
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_minarray"></a>`_.min(array)`
-<a href="#_minarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14197 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.min "See the npm package")
+<a href="#_minarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15416 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.min "See the npm package")
-Computes the minimum value of `array`. If `array` is empty or falsey
+Computes the minimum value of `array`. If `array` is empty or falsey,
`undefined` is returned.
+#### Since
+0.1.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
#### Returns
-*(*)*: Returns the minimum value.
+*(*)*: Returns the minimum value.
#### Example
```js
<!-- div -->
### <a id="_minbyarray-iteratee_identity"></a>`_.minBy(array, [iteratee=_.identity])`
-<a href="#_minbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14225 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.minby "See the npm package")
+<a href="#_minbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15446 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.minby "See the npm package")
This method is like `_.min` except that it accepts `iteratee` which is
invoked for each element in `array` to generate the criterion by which
-the value is ranked. The iteratee is invoked with one argument: (value).
+the value is ranked. The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(*)*: Returns the minimum value.
+*(*)*: Returns the minimum value.
#### Example
```js
<!-- div -->
+### <a id="_multiplymultiplier-multiplicand"></a>`_.multiply(multiplier, multiplicand)`
+<a href="#_multiplymultiplier-multiplicand">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15467 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.multiply "See the npm package")
+
+Multiply two numbers.
+
+#### Since
+4.7.0
+#### Arguments
+1. `multiplier` *(number)*: The first number in a multiplication.
+2. `multiplicand` *(number)*: The second number in a multiplication.
+
+#### Returns
+*(number)*: Returns the product.
+
+#### Example
+```js
+_.multiply(6, 4);
+// => 24
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_roundnumber-precision0"></a>`_.round(number, [precision=0])`
-<a href="#_roundnumber-precision0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14251 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.round "See the npm package")
+<a href="#_roundnumber-precision0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15492 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.round "See the npm package")
Computes `number` rounded to `precision`.
+#### Since
+3.10.0
#### Arguments
1. `number` *(number)*: The number to round.
2. `[precision=0]` *(number)*: The precision to round to.
#### Returns
-*(number)*: Returns the rounded number.
+*(number)*: Returns the rounded number.
#### Example
```js
<!-- div -->
### <a id="_subtractminuend-subtrahend"></a>`_.subtract(minuend, subtrahend)`
-<a href="#_subtractminuend-subtrahend">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14267 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.subtract "See the npm package")
+<a href="#_subtractminuend-subtrahend">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15509 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.subtract "See the npm package")
Subtract two numbers.
+#### Since
+4.0.0
#### Arguments
1. `minuend` *(number)*: The first number in a subtraction.
2. `subtrahend` *(number)*: The second number in a subtraction.
#### Returns
-*(number)*: Returns the difference.
+*(number)*: Returns the difference.
#### Example
```js
<!-- div -->
### <a id="_sumarray"></a>`_.sum(array)`
-<a href="#_sumarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14294 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sum "See the npm package")
+<a href="#_sumarray">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15527 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sum "See the npm package")
Computes the sum of the values in `array`.
+#### Since
+3.4.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
#### Returns
-*(number)*: Returns the sum.
+*(number)*: Returns the sum.
#### Example
```js
<!-- div -->
### <a id="_sumbyarray-iteratee_identity"></a>`_.sumBy(array, [iteratee=_.identity])`
-<a href="#_sumbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14322 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sumby "See the npm package")
+<a href="#_sumbyarray-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15557 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.sumby "See the npm package")
This method is like `_.sum` except that it accepts `iteratee` which is
invoked for each element in `array` to generate the value to be summed.
-The iteratee is invoked with one argument: (value).
+The iteratee is invoked with one argument: *(value)*.
+#### Since
+4.0.0
#### Arguments
1. `array` *(Array)*: The array to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(number)*: Returns the sum.
+*(number)*: Returns the sum.
#### Example
```js
<!-- div -->
### <a id="_clampnumber-lower-upper"></a>`_.clamp(number, [lower], upper)`
-<a href="#_clampnumber-lower-upper">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12074 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clamp "See the npm package")
+<a href="#_clampnumber-lower-upper">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13139 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.clamp "See the npm package")
Clamps `number` within the inclusive `lower` and `upper` bounds.
+#### Since
+4.0.0
#### Arguments
1. `number` *(number)*: The number to clamp.
2. `[lower]` *(number)*: The lower bound.
3. `upper` *(number)*: The upper bound.
#### Returns
-*(number)*: Returns the clamped number.
+*(number)*: Returns the clamped number.
#### Example
```js
<!-- div -->
### <a id="_inrangenumber-start0-end"></a>`_.inRange(number, [start=0], end)`
-<a href="#_inrangenumber-start0-end">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12126 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.inrange "See the npm package")
+<a href="#_inrangenumber-start0-end">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13193 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.inrange "See the npm package")
-Checks if `n` is between `start` and up to but not including, `end`. If
-`end` is not specified it's set to `start` with `start` then set to `0`.
+Checks if `n` is between `start` and up to, but not including, `end`. If
+`end` is not specified, it's set to `start` with `start` then set to `0`.
If `start` is greater than `end` the params are swapped to support
negative ranges.
+#### Since
+3.3.0
#### Arguments
1. `number` *(number)*: The number to check.
2. `[start=0]` *(number)*: The start of the range.
3. `end` *(number)*: The end of the range.
#### Returns
-*(boolean)*: Returns `true` if `number` is in the range, else `false`.
+*(boolean)*: Returns `true` if `number` is in the range, else `false`.
#### Example
```js
<!-- div -->
### <a id="_randomlower0-upper1-floating"></a>`_.random([lower=0], [upper=1], [floating])`
-<a href="#_randomlower0-upper1-floating">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12168 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.random "See the npm package")
+<a href="#_randomlower0-upper1-floating">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13236 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.random "See the npm package")
Produces a random number between the inclusive `lower` and `upper` bounds.
If only one argument is provided a number between `0` and the given number
-is returned. If `floating` is `true`, or either `lower` or `upper` are floats,
-a floating-point number is returned instead of an integer.
+is returned. If `floating` is `true`, or either `lower` or `upper` are
+floats, a floating-point number is returned instead of an integer.
<br>
<br>
**Note:** JavaScript follows the IEEE-754 standard for resolving
floating-point values which can produce unexpected results.
+#### Since
+0.7.0
#### Arguments
1. `[lower=0]` *(number)*: The lower bound.
2. `[upper=1]` *(number)*: The upper bound.
3. `[floating]` *(boolean)*: Specify returning a floating-point number.
#### Returns
-*(number)*: Returns the random number.
+*(number)*: Returns the random number.
#### Example
```js
<!-- div -->
### <a id="_assignobject-sources"></a>`_.assign(object, [sources])`
-<a href="#_assignobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10838 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assign "See the npm package")
+<a href="#_assignobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11752 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assign "See the npm package")
-Assigns own enumerable properties of source objects to the destination
-object. Source objects are applied from left to right. Subsequent sources
-overwrite property assignments of previous sources.
+Assigns own enumerable string keyed properties of source objects to the
+destination object. Source objects are applied from left to right.
+Subsequent sources overwrite property assignments of previous sources.
<br>
<br>
**Note:** This method mutates `object` and is loosely based on
[`Object.assign`](https://mdn.io/Object/assign).
+#### Since
+0.10.0
#### Arguments
1. `object` *(Object)*: The destination object.
2. `[sources]` *(...Object)*: The source objects.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_assigninobject-sources"></a>`_.assignIn(object, [sources])`
-<a href="#_assigninobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10871 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assignin "See the npm package")
+<a href="#_assigninobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11795 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assignin "See the npm package")
This method is like `_.assign` except that it iterates over own and
inherited source properties.
<br>
**Note:** This method mutates `object`.
+#### Since
+4.0.0
#### Aliases
*_.extend*
2. `[sources]` *(...Object)*: The source objects.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_assigninwithobject-sources-customizer"></a>`_.assignInWith(object, sources, [customizer])`
-<a href="#_assigninwithobject-sources-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10902 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assigninwith "See the npm package")
+<a href="#_assigninwithobject-sources-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11834 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assigninwith "See the npm package")
-This method is like `_.assignIn` except that it accepts `customizer` which
-is invoked to produce the assigned values. If `customizer` returns `undefined`
-assignment is handled by the method instead. The `customizer` is invoked
-with five arguments: (objValue, srcValue, key, object, source).
+This method is like `_.assignIn` except that it accepts `customizer`
+which is invoked to produce the assigned values. If `customizer` returns
+`undefined`, assignment is handled by the method instead. The `customizer`
+is invoked with five arguments: *(objValue, srcValue, key, object, source)*.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+4.0.0
#### Aliases
*_.extendWith*
3. `[customizer]` *(Function)*: The function to customize assigned values.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_assignwithobject-sources-customizer"></a>`_.assignWith(object, sources, [customizer])`
-<a href="#_assignwithobject-sources-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10932 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assignwith "See the npm package")
+<a href="#_assignwithobject-sources-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11866 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.assignwith "See the npm package")
-This method is like `_.assign` except that it accepts `customizer` which
-is invoked to produce the assigned values. If `customizer` returns `undefined`
-assignment is handled by the method instead. The `customizer` is invoked
-with five arguments: (objValue, srcValue, key, object, source).
+This method is like `_.assign` except that it accepts `customizer`
+which is invoked to produce the assigned values. If `customizer` returns
+`undefined`, assignment is handled by the method instead. The `customizer`
+is invoked with five arguments: *(objValue, srcValue, key, object, source)*.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The destination object.
2. `sources` *(...Object)*: The source objects.
3. `[customizer]` *(Function)*: The function to customize assigned values.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_atobject-paths"></a>`_.at(object, [paths])`
-<a href="#_atobject-paths">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10956 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.at "See the npm package")
+<a href="#_atobject-paths">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11890 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.at "See the npm package")
Creates an array of values corresponding to `paths` of `object`.
+#### Since
+1.0.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
-2. `[paths]` *(...(string|string[])*: The property paths of elements to pick, specified individually or in arrays.
+2. `[paths]` *(...(string|string[]))*: The property paths of elements to pick.
#### Returns
-*(Array)*: Returns the new array of picked elements.
+*(Array)*: Returns the new array of picked elements.
#### Example
```js
<!-- div -->
### <a id="_createprototype-properties"></a>`_.create(prototype, [properties])`
-<a href="#_createprototype-properties">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L10992 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.create "See the npm package")
+<a href="#_createprototype-properties">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11928 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.create "See the npm package")
-Creates an object that inherits from the `prototype` object. If a `properties`
-object is given its own enumerable properties are assigned to the created object.
+Creates an object that inherits from the `prototype` object. If a
+`properties` object is given, its own enumerable string keyed properties
+are assigned to the created object.
+#### Since
+2.3.0
#### Arguments
1. `prototype` *(Object)*: The object to inherit from.
2. `[properties]` *(Object)*: The properties to assign to the object.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_defaultsobject-sources"></a>`_.defaults(object, [sources])`
-<a href="#_defaultsobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11016 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.defaults "See the npm package")
+<a href="#_defaultsobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11954 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.defaults "See the npm package")
-Assigns own and inherited enumerable properties of source objects to the
-destination object for all destination properties that resolve to `undefined`.
-Source objects are applied from left to right. Once a property is set,
-additional values of the same property are ignored.
+Assigns own and inherited enumerable string keyed properties of source
+objects to the destination object for all destination properties that
+resolve to `undefined`. Source objects are applied from left to right.
+Once a property is set, additional values of the same property are ignored.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The destination object.
2. `[sources]` *(...Object)*: The source objects.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_defaultsdeepobject-sources"></a>`_.defaultsDeep(object, [sources])`
-<a href="#_defaultsdeepobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11039 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.defaultsdeep "See the npm package")
+<a href="#_defaultsdeepobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L11979 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.defaultsdeep "See the npm package")
This method is like `_.defaults` except that it recursively assigns
default properties.
<br>
**Note:** This method mutates `object`.
+#### Since
+3.10.0
#### Arguments
1. `object` *(Object)*: The destination object.
2. `[sources]` *(...Object)*: The source objects.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_findkeyobject-predicate_identity"></a>`_.findKey(object, [predicate=_.identity])`
-<a href="#_findkeyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11077 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findkey "See the npm package")
+<a href="#_findkeyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12020 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findkey "See the npm package")
This method is like `_.find` except that it returns the key of the first
element `predicate` returns truthy for instead of the element itself.
+#### Since
+1.1.0
#### Arguments
1. `object` *(Object)*: The object to search.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(string|undefined)*: Returns the key of the matched element, else `undefined`.
+*(*)*: Returns the key of the matched element, else `undefined`.
#### Example
```js
<!-- div -->
### <a id="_findlastkeyobject-predicate_identity"></a>`_.findLastKey(object, [predicate=_.identity])`
-<a href="#_findlastkeyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11114 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findlastkey "See the npm package")
+<a href="#_findlastkeyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12060 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.findlastkey "See the npm package")
This method is like `_.findKey` except that it iterates over elements of
a collection in the opposite order.
+#### Since
+2.0.0
#### Arguments
1. `object` *(Object)*: The object to search.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(string|undefined)*: Returns the key of the matched element, else `undefined`.
+*(*)*: Returns the key of the matched element, else `undefined`.
#### Example
```js
<!-- div -->
### <a id="_forinobject-iteratee_identity"></a>`_.forIn(object, [iteratee=_.identity])`
-<a href="#_forinobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11144 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forin "See the npm package")
+<a href="#_forinobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12092 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forin "See the npm package")
-Iterates over own and inherited enumerable properties of an object invoking
-`iteratee` for each property. The iteratee is invoked with three arguments:<br>
-(value, key, object). Iteratee functions may exit iteration early by explicitly
-returning `false`.
+Iterates over own and inherited enumerable string keyed properties of an
+object and invokes `iteratee` for each property. The iteratee is invoked
+with three arguments: *(value, key, object)*. Iteratee functions may exit
+iteration early by explicitly returning `false`.
+#### Since
+0.3.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
_.forIn(new Foo, function(value, key) {
console.log(key);
});
-// => logs 'a', 'b', then 'c' (iteration order is not guaranteed)
+// => Logs 'a', 'b', then 'c' (iteration order is not guaranteed).
```
* * *
<!-- div -->
### <a id="_forinrightobject-iteratee_identity"></a>`_.forInRight(object, [iteratee=_.identity])`
-<a href="#_forinrightobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11174 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forinright "See the npm package")
+<a href="#_forinrightobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12124 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forinright "See the npm package")
This method is like `_.forIn` except that it iterates over properties of
`object` in the opposite order.
+#### Since
+2.0.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
_.forInRight(new Foo, function(value, key) {
console.log(key);
});
-// => logs 'c', 'b', then 'a' assuming `_.forIn` logs 'a', 'b', then 'c'
+// => Logs 'c', 'b', then 'a' assuming `_.forIn` logs 'a', 'b', then 'c'.
```
* * *
<!-- div -->
### <a id="_forownobject-iteratee_identity"></a>`_.forOwn(object, [iteratee=_.identity])`
-<a href="#_forownobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11206 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forown "See the npm package")
+<a href="#_forownobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12158 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forown "See the npm package")
-Iterates over own enumerable properties of an object invoking `iteratee`
-for each property. The iteratee is invoked with three arguments:<br>
-(value, key, object). Iteratee functions may exit iteration early by
-explicitly returning `false`.
+Iterates over own enumerable string keyed properties of an object and
+invokes `iteratee` for each property. The iteratee is invoked with three
+arguments: *(value, key, object)*. Iteratee functions may exit iteration
+early by explicitly returning `false`.
+#### Since
+0.3.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
_.forOwn(new Foo, function(value, key) {
console.log(key);
});
-// => logs 'a' then 'b' (iteration order is not guaranteed)
+// => Logs 'a' then 'b' (iteration order is not guaranteed).
```
* * *
<!-- div -->
### <a id="_forownrightobject-iteratee_identity"></a>`_.forOwnRight(object, [iteratee=_.identity])`
-<a href="#_forownrightobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11234 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forownright "See the npm package")
+<a href="#_forownrightobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12188 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.forownright "See the npm package")
This method is like `_.forOwn` except that it iterates over properties of
`object` in the opposite order.
+#### Since
+2.0.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
_.forOwnRight(new Foo, function(value, key) {
console.log(key);
});
-// => logs 'b' then 'a' assuming `_.forOwn` logs 'a' then 'b'
+// => Logs 'b' then 'a' assuming `_.forOwn` logs 'a' then 'b'.
```
* * *
<!-- div -->
### <a id="_functionsobject"></a>`_.functions(object)`
-<a href="#_functionsobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11259 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.functions "See the npm package")
+<a href="#_functionsobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12215 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.functions "See the npm package")
Creates an array of function property names from own enumerable properties
of `object`.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The object to inspect.
#### Returns
-*(Array)*: Returns the new array of property names.
+*(Array)*: Returns the new array of property names.
#### Example
```js
<!-- div -->
### <a id="_functionsinobject"></a>`_.functionsIn(object)`
-<a href="#_functionsinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11284 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.functionsin "See the npm package")
+<a href="#_functionsinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12242 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.functionsin "See the npm package")
Creates an array of function property names from own and inherited
enumerable properties of `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The object to inspect.
#### Returns
-*(Array)*: Returns the new array of property names.
+*(Array)*: Returns the new array of property names.
#### Example
```js
<!-- div -->
### <a id="_getobject-path-defaultvalue"></a>`_.get(object, path, [defaultValue])`
-<a href="#_getobject-path-defaultvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11312 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.get "See the npm package")
+<a href="#_getobject-path-defaultvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12271 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.get "See the npm package")
Gets the value at `path` of `object`. If the resolved value is
-`undefined` the `defaultValue` is used in its place.
+`undefined`, the `defaultValue` is used in its place.
+#### Since
+3.7.0
#### Arguments
1. `object` *(Object)*: The object to query.
2. `path` *(Array|string)*: The path of the property to get.
-3. `[defaultValue]` *(*)*: The value returned if the resolved value is `undefined`.
+3. `[defaultValue]` *(*)*: The value returned for `undefined` resolved values.
#### Returns
-*(*)*: Returns the resolved value.
+*(*)*: Returns the resolved value.
#### Example
```js
<!-- div -->
### <a id="_hasobject-path"></a>`_.has(object, path)`
-<a href="#_hasobject-path">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11343 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.has "See the npm package")
+<a href="#_hasobject-path">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12303 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.has "See the npm package")
Checks if `path` is a direct property of `object`.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The object to query.
2. `path` *(Array|string)*: The path to check.
#### Returns
-*(boolean)*: Returns `true` if `path` exists, else `false`.
+*(boolean)*: Returns `true` if `path` exists, else `false`.
#### Example
```js
-var object = { 'a': { 'b': { 'c': 3 } } };
-var other = _.create({ 'a': _.create({ 'b': _.create({ 'c': 3 }) }) });
+var object = { 'a': { 'b': 2 } };
+var other = _.create({ 'a': _.create({ 'b': 2 }) });
_.has(object, 'a');
// => true
-_.has(object, 'a.b.c');
+_.has(object, 'a.b');
// => true
-_.has(object, ['a', 'b', 'c']);
+_.has(object, ['a', 'b']);
// => true
_.has(other, 'a');
<!-- div -->
### <a id="_hasinobject-path"></a>`_.hasIn(object, path)`
-<a href="#_hasinobject-path">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11372 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.hasin "See the npm package")
+<a href="#_hasinobject-path">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12333 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.hasin "See the npm package")
Checks if `path` is a direct or inherited property of `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The object to query.
2. `path` *(Array|string)*: The path to check.
#### Returns
-*(boolean)*: Returns `true` if `path` exists, else `false`.
+*(boolean)*: Returns `true` if `path` exists, else `false`.
#### Example
```js
-var object = _.create({ 'a': _.create({ 'b': _.create({ 'c': 3 }) }) });
+var object = _.create({ 'a': _.create({ 'b': 2 }) });
_.hasIn(object, 'a');
// => true
-_.hasIn(object, 'a.b.c');
+_.hasIn(object, 'a.b');
// => true
-_.hasIn(object, ['a', 'b', 'c']);
+_.hasIn(object, ['a', 'b']);
// => true
_.hasIn(object, 'b');
<!-- div -->
### <a id="_invertobject"></a>`_.invert(object)`
-<a href="#_invertobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11393 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invert "See the npm package")
+<a href="#_invertobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12355 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invert "See the npm package")
Creates an object composed of the inverted keys and values of `object`.
-If `object` contains duplicate values, subsequent values overwrite property
-assignments of previous values.
+If `object` contains duplicate values, subsequent values overwrite
+property assignments of previous values.
+#### Since
+0.7.0
#### Arguments
1. `object` *(Object)*: The object to invert.
#### Returns
-*(Object)*: Returns the new inverted object.
+*(Object)*: Returns the new inverted object.
#### Example
```js
<!-- div -->
### <a id="_invertbyobject-iteratee_identity"></a>`_.invertBy(object, [iteratee=_.identity])`
-<a href="#_invertbyobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11422 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invertby "See the npm package")
+<a href="#_invertbyobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12386 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invertby "See the npm package")
This method is like `_.invert` except that the inverted object is generated
-from the results of running each element of `object` through `iteratee`.
-The corresponding inverted value of each inverted key is an array of keys
+from the results of running each element of `object` thru `iteratee`. The
+corresponding inverted value of each inverted key is an array of keys
responsible for generating the inverted value. The iteratee is invoked
-with one argument: (value).
+with one argument: *(value)*.
+#### Since
+4.1.0
#### Arguments
1. `object` *(Object)*: The object to invert.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The iteratee invoked per element.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The iteratee invoked per element.
#### Returns
-*(Object)*: Returns the new inverted object.
+*(Object)*: Returns the new inverted object.
#### Example
```js
<!-- div -->
### <a id="_invokeobject-path-args"></a>`_.invoke(object, path, [args])`
-<a href="#_invokeobject-path-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11447 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invoke "See the npm package")
+<a href="#_invokeobject-path-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12412 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.invoke "See the npm package")
Invokes the method at `path` of `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The object to query.
2. `path` *(Array|string)*: The path of the method to invoke.
3. `[args]` *(...*)*: The arguments to invoke the method with.
#### Returns
-*(*)*: Returns the result of the invoked method.
+*(*)*: Returns the result of the invoked method.
#### Example
```js
<!-- div -->
### <a id="_keysobject"></a>`_.keys(object)`
-<a href="#_keysobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11476 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.keys "See the npm package")
+<a href="#_keysobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12442 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.keys "See the npm package")
Creates an array of the own enumerable property names of `object`.
<br>
[ES spec](http://ecma-international.org/ecma-262/6.0/#sec-object.keys)
for more details.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Array)*: Returns the array of property names.
+*(Array)*: Returns the array of property names.
#### Example
```js
<!-- div -->
### <a id="_keysinobject"></a>`_.keysIn(object)`
-<a href="#_keysinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11518 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.keysin "See the npm package")
+<a href="#_keysinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12485 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.keysin "See the npm package")
Creates an array of the own and inherited enumerable property names of `object`.
<br>
<br>
**Note:** Non-object values are coerced to objects.
+#### Since
+3.0.0
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Array)*: Returns the array of property names.
+*(Array)*: Returns the array of property names.
#### Example
```js
<!-- div -->
### <a id="_mapkeysobject-iteratee_identity"></a>`_.mapKeys(object, [iteratee=_.identity])`
-<a href="#_mapkeysobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11557 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mapkeys "See the npm package")
+<a href="#_mapkeysobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12527 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mapkeys "See the npm package")
The opposite of `_.mapValues`; this method creates an object with the
same values as `object` and keys generated by running each own enumerable
-property of `object` through `iteratee`. The iteratee is invoked with
-three arguments: (value, key, object).
+string keyed property of `object` thru `iteratee`. The iteratee is invoked
+with three arguments: *(value, key, object)*.
+#### Since
+3.8.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Object)*: Returns the new mapped object.
+*(Object)*: Returns the new mapped object.
#### Example
```js
<!-- div -->
### <a id="_mapvaluesobject-iteratee_identity"></a>`_.mapValues(object, [iteratee=_.identity])`
-<a href="#_mapvaluesobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11592 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mapvalues "See the npm package")
+<a href="#_mapvaluesobject-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12566 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mapvalues "See the npm package")
-Creates an object with the same keys as `object` and values generated by
-running each own enumerable property of `object` through `iteratee`. The
-iteratee is invoked with three arguments: (value, key, object).
+Creates an object with the same keys as `object` and values generated
+by running each own enumerable string keyed property of `object` thru
+`iteratee`. The iteratee is invoked with three arguments:<br>
+*(value, key, object)*.
+#### Since
+2.4.0
#### Arguments
1. `object` *(Object)*: The object to iterate over.
-2. `[iteratee=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
+2. `[iteratee=_.identity]` *(Array|Function|Object|string)*: The function invoked per iteration.
#### Returns
-*(Object)*: Returns the new mapped object.
+*(Object)*: Returns the new mapped object.
#### Example
```js
<!-- div -->
### <a id="_mergeobject-sources"></a>`_.merge(object, [sources])`
-<a href="#_mergeobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11631 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.merge "See the npm package")
+<a href="#_mergeobject-sources">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12607 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.merge "See the npm package")
-Recursively merges own and inherited enumerable properties of source objects
-into the destination object. Source properties that resolve to `undefined`
-are skipped if a destination value exists. Array and plain object properties
-are merged recursively. Other objects and value types are overridden by
+This method is like `_.assign` except that it recursively merges own and
+inherited enumerable string keyed properties of source objects into the
+destination object. Source properties that resolve to `undefined` are
+skipped if a destination value exists. Array and plain object properties
+are merged recursively.Other objects and value types are overridden by
assignment. Source objects are applied from left to right. Subsequent
sources overwrite property assignments of previous sources.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+0.5.0
#### Arguments
1. `object` *(Object)*: The destination object.
2. `[sources]` *(...Object)*: The source objects.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_mergewithobject-sources-customizer"></a>`_.mergeWith(object, sources, customizer)`
-<a href="#_mergewithobject-sources-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11672 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mergewith "See the npm package")
+<a href="#_mergewithobject-sources-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12649 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mergewith "See the npm package")
This method is like `_.merge` except that it accepts `customizer` which
is invoked to produce the merged values of the destination and source
-properties. If `customizer` returns `undefined` merging is handled by the
+properties. If `customizer` returns `undefined`, merging is handled by the
method instead. The `customizer` is invoked with seven arguments:<br>
-(objValue, srcValue, key, object, source, stack).
+*(objValue, srcValue, key, object, source, stack)*.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The destination object.
2. `sources` *(...Object)*: The source objects.
3. `customizer` *(Function)*: The function to customize assigned values.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_omitobject-props"></a>`_.omit(object, [props])`
-<a href="#_omitobject-props">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11694 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.omit "See the npm package")
+<a href="#_omitobject-props">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12672 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.omit "See the npm package")
The opposite of `_.pick`; this method creates an object composed of the
-own and inherited enumerable properties of `object` that are not omitted.
+own and inherited enumerable string keyed properties of `object` that are
+not omitted.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The source object.
-2. `[props]` *(...(string|string[])*: The property names to omit, specified individually or in arrays.
+2. `[props]` *(...(string|string[]))*: The property identifiers to omit.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_omitbyobject-predicate_identity"></a>`_.omitBy(object, [predicate=_.identity])`
-<a href="#_omitbyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11721 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.omitby "See the npm package")
+<a href="#_omitbyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12701 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.omitby "See the npm package")
The opposite of `_.pickBy`; this method creates an object composed of
-the own and inherited enumerable properties of `object` that `predicate`
-doesn't return truthy for. The predicate is invoked with two arguments:<br>
-(value, key).
+the own and inherited enumerable string keyed properties of `object` that
+`predicate` doesn't return truthy for. The predicate is invoked with two
+arguments: *(value, key)*.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The source object.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per property.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per property.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_pickobject-props"></a>`_.pick(object, [props])`
-<a href="#_pickobject-props">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11745 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pick "See the npm package")
+<a href="#_pickobject-props">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12725 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pick "See the npm package")
Creates an object composed of the picked `object` properties.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The source object.
-2. `[props]` *(...(string|string[])*: The property names to pick, specified individually or in arrays.
+2. `[props]` *(...(string|string[]))*: The property identifiers to pick.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_pickbyobject-predicate_identity"></a>`_.pickBy(object, [predicate=_.identity])`
-<a href="#_pickbyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11766 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pickby "See the npm package")
+<a href="#_pickbyobject-predicate_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12748 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pickby "See the npm package")
Creates an object composed of the `object` properties `predicate` returns
-truthy for. The predicate is invoked with two arguments: (value, key).
+truthy for. The predicate is invoked with two arguments: *(value, key)*.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The source object.
-2. `[predicate=_.identity]` *(Function|Object|string)*: The function invoked per property.
+2. `[predicate=_.identity]` *(Array|Function|Object|string)*: The function invoked per property.
#### Returns
-*(Object)*: Returns the new object.
+*(Object)*: Returns the new object.
#### Example
```js
<!-- div -->
### <a id="_resultobject-path-defaultvalue"></a>`_.result(object, path, [defaultValue])`
-<a href="#_resultobject-path-defaultvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11798 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.result "See the npm package")
+<a href="#_resultobject-path-defaultvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12781 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.result "See the npm package")
-This method is like `_.get` except that if the resolved value is a function
-it's invoked with the `this` binding of its parent object and its result
-is returned.
+This method is like `_.get` except that if the resolved value is a
+function it's invoked with the `this` binding of its parent object and
+its result is returned.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The object to query.
2. `path` *(Array|string)*: The path of the property to resolve.
-3. `[defaultValue]` *(*)*: The value returned if the resolved value is `undefined`.
+3. `[defaultValue]` *(*)*: The value returned for `undefined` resolved values.
#### Returns
-*(*)*: Returns the resolved value.
+*(*)*: Returns the resolved value.
#### Example
```js
<!-- div -->
### <a id="_setobject-path-value"></a>`_.set(object, path, value)`
-<a href="#_setobject-path-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11839 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.set "See the npm package")
+<a href="#_setobject-path-value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12831 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.set "See the npm package")
-Sets the value at `path` of `object`. If a portion of `path` doesn't exist
+Sets the value at `path` of `object`. If a portion of `path` doesn't exist,
it's created. Arrays are created for missing index properties while objects
are created for all other missing properties. Use `_.setWith` to customize
`path` creation.
<br>
**Note:** This method mutates `object`.
+#### Since
+3.7.0
#### Arguments
1. `object` *(Object)*: The object to modify.
2. `path` *(Array|string)*: The path of the property to set.
3. `value` *(*)*: The value to set.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
console.log(object.a[0].b.c);
// => 4
-_.set(object, 'x[0].y.z', 5);
+_.set(object, ['x', '0', 'y', 'z'], 5);
console.log(object.x[0].y.z);
// => 5
```
<!-- div -->
### <a id="_setwithobject-path-value-customizer"></a>`_.setWith(object, path, value, [customizer])`
-<a href="#_setwithobject-path-value-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11864 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.setwith "See the npm package")
+<a href="#_setwithobject-path-value-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12859 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.setwith "See the npm package")
This method is like `_.set` except that it accepts `customizer` which is
invoked to produce the objects of `path`. If `customizer` returns `undefined`
path creation is handled by the method instead. The `customizer` is invoked
-with three arguments: (nsValue, key, nsObject).
+with three arguments: *(nsValue, key, nsObject)*.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The object to modify.
2. `path` *(Array|string)*: The path of the property to set.
4. `[customizer]` *(Function)*: The function to customize assigned values.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
-_.setWith({ '0': { 'length': 2 } }, '[0][1][2]', 3, Object);
-// => { '0': { '1': { '2': 3 }, 'length': 2 } }
+var object = {};
+
+_.setWith(object, '[0][1]', 'a', Object);
+// => { '0': { '1': 'a' } }
```
* * *
<!-- div -->
### <a id="_topairsobject"></a>`_.toPairs(object)`
-<a href="#_topairsobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11890 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.topairs "See the npm package")
+<a href="#_topairsobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12887 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.topairs "See the npm package")
-Creates an array of own enumerable key-value pairs for `object` which
-can be consumed by `_.fromPairs`.
+Creates an array of own enumerable string keyed-value pairs for `object`
+which can be consumed by `_.fromPairs`.
+
+#### Since
+4.0.0
+#### Aliases
+*_.entries*
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Array)*: Returns the new array of key-value pairs.
+*(Array)*: Returns the new array of key-value pairs.
#### Example
```js
<!-- div -->
### <a id="_topairsinobject"></a>`_.toPairsIn(object)`
-<a href="#_topairsinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11915 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.topairsin "See the npm package")
+<a href="#_topairsinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12914 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.topairsin "See the npm package")
-Creates an array of own and inherited enumerable key-value pairs for
-`object` which can be consumed by `_.fromPairs`.
+Creates an array of own and inherited enumerable string keyed-value pairs
+for `object` which can be consumed by `_.fromPairs`.
+
+#### Since
+4.0.0
+#### Aliases
+*_.entriesIn*
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Array)*: Returns the new array of key-value pairs.
+*(Array)*: Returns the new array of key-value pairs.
#### Example
```js
<!-- div -->
### <a id="_transformobject-iteratee_identity-accumulator"></a>`_.transform(object, [iteratee=_.identity], [accumulator])`
-<a href="#_transformobject-iteratee_identity-accumulator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11947 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.transform "See the npm package")
+<a href="#_transformobject-iteratee_identity-accumulator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12947 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.transform "See the npm package")
An alternative to `_.reduce`; this method transforms `object` to a new
-`accumulator` object which is the result of running each of its own enumerable
-properties through `iteratee`, with each invocation potentially mutating
-the `accumulator` object. The iteratee is invoked with four arguments:<br>
-(accumulator, value, key, object). Iteratee functions may exit iteration
-early by explicitly returning `false`.
+`accumulator` object which is the result of running each of its own
+enumerable string keyed properties thru `iteratee`, with each invocation
+potentially mutating the `accumulator` object. The iteratee is invoked
+with four arguments: *(accumulator, value, key, object)*. Iteratee functions
+may exit iteration early by explicitly returning `false`.
+#### Since
+1.3.0
#### Arguments
1. `object` *(Array|Object)*: The object to iterate over.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
3. `[accumulator]` *(*)*: The custom accumulator value.
#### Returns
-*(*)*: Returns the accumulated value.
+*(*)*: Returns the accumulated value.
#### Example
```js
<!-- div -->
### <a id="_unsetobject-path"></a>`_.unset(object, path)`
-<a href="#_unsetobject-path">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L11995 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unset "See the npm package")
+<a href="#_unsetobject-path">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L12996 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unset "See the npm package")
Removes the property at `path` of `object`.
<br>
<br>
**Note:** This method mutates `object`.
+#### Since
+4.0.0
#### Arguments
1. `object` *(Object)*: The object to modify.
2. `path` *(Array|string)*: The path of the property to unset.
#### Returns
-*(boolean)*: Returns `true` if the property is deleted, else `false`.
+*(boolean)*: Returns `true` if the property is deleted, else `false`.
#### Example
```js
console.log(object);
// => { 'a': [{ 'b': {} }] };
-_.unset(object, 'a[0].b.c');
+_.unset(object, ['a', '0', 'b', 'c']);
// => true
console.log(object);
<!-- div -->
+### <a id="_updateobject-path-updater"></a>`_.update(object, path, updater)`
+<a href="#_updateobject-path-updater">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13027 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.update "See the npm package")
+
+This method is like `_.set` except that accepts `updater` to produce the
+value to set. Use `_.updateWith` to customize `path` creation. The `updater`
+is invoked with one argument: *(value)*.
+<br>
+<br>
+**Note:** This method mutates `object`.
+
+#### Since
+4.6.0
+#### Arguments
+1. `object` *(Object)*: The object to modify.
+2. `path` *(Array|string)*: The path of the property to set.
+3. `updater` *(Function)*: The function to produce the updated value.
+
+#### Returns
+*(Object)*: Returns `object`.
+
+#### Example
+```js
+var object = { 'a': [{ 'b': { 'c': 3 } }] };
+
+_.update(object, 'a[0].b.c', function(n) { return n * n; });
+console.log(object.a[0].b.c);
+// => 9
+
+_.update(object, 'x[0].y.z', function(n) { return n ? n + 1 : 0; });
+console.log(object.x[0].y.z);
+// => 0
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
+### <a id="_updatewithobject-path-updater-customizer"></a>`_.updateWith(object, path, updater, [customizer])`
+<a href="#_updatewithobject-path-updater-customizer">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13055 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.updatewith "See the npm package")
+
+This method is like `_.update` except that it accepts `customizer` which is
+invoked to produce the objects of `path`. If `customizer` returns `undefined`
+path creation is handled by the method instead. The `customizer` is invoked
+with three arguments: *(nsValue, key, nsObject)*.
+<br>
+<br>
+**Note:** This method mutates `object`.
+
+#### Since
+4.6.0
+#### Arguments
+1. `object` *(Object)*: The object to modify.
+2. `path` *(Array|string)*: The path of the property to set.
+3. `updater` *(Function)*: The function to produce the updated value.
+4. `[customizer]` *(Function)*: The function to customize assigned values.
+
+#### Returns
+*(Object)*: Returns `object`.
+
+#### Example
+```js
+var object = {};
+
+_.updateWith(object, '[0][1]', _.constant('a'), Object);
+// => { '0': { '1': 'a' } }
+```
+* * *
+
+<!-- /div -->
+
+<!-- div -->
+
### <a id="_valuesobject"></a>`_.values(object)`
-<a href="#_valuesobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12024 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.values "See the npm package")
+<a href="#_valuesobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13086 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.values "See the npm package")
-Creates an array of the own enumerable property values of `object`.
+Creates an array of the own enumerable string keyed property values of `object`.
<br>
<br>
**Note:** Non-object values are coerced to objects.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Array)*: Returns the array of property values.
+*(Array)*: Returns the array of property values.
#### Example
```js
<!-- div -->
### <a id="_valuesinobject"></a>`_.valuesIn(object)`
-<a href="#_valuesinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12050 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.valuesin "See the npm package")
+<a href="#_valuesinobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13114 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.valuesin "See the npm package")
-Creates an array of the own and inherited enumerable property values of `object`.
+Creates an array of the own and inherited enumerable string keyed property
+values of `object`.
<br>
<br>
**Note:** Non-object values are coerced to objects.
+#### Since
+3.0.0
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Array)*: Returns the array of property values.
+*(Array)*: Returns the array of property values.
#### Example
```js
<!-- div -->
### <a id="_value"></a>`_(value)`
-<a href="#_value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1500 "View in source") [Ⓣ][1]
+<a href="#_value">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1457 "View in source") [Ⓣ][1]
Creates a `lodash` object which wraps `value` to enable implicit method
-chaining. Methods that operate on and return arrays, collections, and
-functions can be chained together. Methods that retrieve a single value or
-may return a primitive value will automatically end the chain sequence and
-return the unwrapped value. Otherwise, the value must be unwrapped with
-`_#value`.
+chain sequences. Methods that operate on and return arrays, collections,
+and functions can be chained together. Methods that retrieve a single value
+or may return a primitive value will automatically end the chain sequence
+and return the unwrapped value. Otherwise, the value must be unwrapped
+with `_#value`.
<br>
<br>
-Explicit chaining, which must be unwrapped with `_#value` in all cases,
-may be enabled using `_.chain`.
+Explicit chain sequences, which must be unwrapped with `_#value`, may be
+enabled using `_.chain`.
<br>
<br>
The execution of chained methods is lazy, that is, it's deferred until
`_#value` is implicitly or explicitly called.
<br>
<br>
-Lazy evaluation allows several methods to support shortcut fusion. Shortcut
-fusion is an optimization to merge iteratee calls; this avoids the creation
-of intermediate arrays and can greatly reduce the number of iteratee executions.
-Sections of a chain sequence qualify for shortcut fusion if the section is
-applied to an array of at least two hundred elements and any iteratees
-accept only one argument. The heuristic for whether a section qualifies
-for shortcut fusion is subject to change.
+Lazy evaluation allows several methods to support shortcut fusion.
+Shortcut fusion is an optimization to merge iteratee calls; this avoids
+the creation of intermediate arrays and can greatly reduce the number of
+iteratee executions. Sections of a chain sequence qualify for shortcut
+fusion if the section is applied to an array of at least `200` elements
+and any iteratees accept only one argument. The heuristic for whether a
+section qualifies for shortcut fusion is subject to change.
<br>
<br>
Chaining is supported in custom builds as long as the `_#value` method is
`after`, `ary`, `assign`, `assignIn`, `assignInWith`, `assignWith`, `at`,
`before`, `bind`, `bindAll`, `bindKey`, `castArray`, `chain`, `chunk`,
`commit`, `compact`, `concat`, `conforms`, `constant`, `countBy`, `create`,
-`curry`, `debounce`, `defaults`, `defaultsDeep`, `defer`, `delay`, `difference`,
-`differenceBy`, `differenceWith`, `drop`, `dropRight`, `dropRightWhile`,
-`dropWhile`, `fill`, `filter`, `flatten`, `flattenDeep`, `flattenDepth`,
-`flip`, `flow`, `flowRight`, `fromPairs`, `functions`, `functionsIn`,
-`groupBy`, `initial`, `intersection`, `intersectionBy`, `intersectionWith`,
-`invert`, `invertBy`, `invokeMap`, `iteratee`, `keyBy`, `keys`, `keysIn`,
-`map`, `mapKeys`, `mapValues`, `matches`, `matchesProperty`, `memoize`,
-`merge`, `mergeWith`, `method`, `methodOf`, `mixin`, `negate`, `nthArg`,
-`omit`, `omitBy`, `once`, `orderBy`, `over`, `overArgs`, `overEvery`,
-`overSome`, `partial`, `partialRight`, `partition`, `pick`, `pickBy`, `plant`,
-`property`, `propertyOf`, `pull`, `pullAll`, `pullAllBy`, `pullAt`, `push`,
-`range`, `rangeRight`, `rearg`, `reject`, `remove`, `rest`, `reverse`,
-`sampleSize`, `set`, `setWith`, `shuffle`, `slice`, `sort`, `sortBy`,
-`splice`, `spread`, `tail`, `take`, `takeRight`, `takeRightWhile`,
-`takeWhile`, `tap`, `throttle`, `thru`, `toArray`, `toPairs`, `toPairsIn`,
-`toPath`, `toPlainObject`, `transform`, `unary`, `union`, `unionBy`,
-`unionWith`, `uniq`, `uniqBy`, `uniqWith`, `unset`, `unshift`, `unzip`,
-`unzipWith`, `values`, `valuesIn`, `without`, `wrap`, `xor`, `xorBy`,
-`xorWith`, `zip`, `zipObject`, `zipObjectDeep`, and `zipWith`
+`curry`, `debounce`, `defaults`, `defaultsDeep`, `defer`, `delay`,
+`difference`, `differenceBy`, `differenceWith`, `drop`, `dropRight`,
+`dropRightWhile`, `dropWhile`, `extend`, `extendWith`, `fill`, `filter`,
+`flatMap`, `flatMapDeep`, `flatMapDepth`, `flatten`, `flattenDeep`,
+`flattenDepth`, `flip`, `flow`, `flowRight`, `fromPairs`, `functions`,
+`functionsIn`, `groupBy`, `initial`, `intersection`, `intersectionBy`,
+`intersectionWith`, `invert`, `invertBy`, `invokeMap`, `iteratee`, `keyBy`,
+`keys`, `keysIn`, `map`, `mapKeys`, `mapValues`, `matches`, `matchesProperty`,
+`memoize`, `merge`, `mergeWith`, `method`, `methodOf`, `mixin`, `negate`,
+`nthArg`, `omit`, `omitBy`, `once`, `orderBy`, `over`, `overArgs`,
+`overEvery`, `overSome`, `partial`, `partialRight`, `partition`, `pick`,
+`pickBy`, `plant`, `property`, `propertyOf`, `pull`, `pullAll`, `pullAllBy`,
+`pullAllWith`, `pullAt`, `push`, `range`, `rangeRight`, `rearg`, `reject`,
+`remove`, `rest`, `reverse`, `sampleSize`, `set`, `setWith`, `shuffle`,
+`slice`, `sort`, `sortBy`, `splice`, `spread`, `tail`, `take`, `takeRight`,
+`takeRightWhile`, `takeWhile`, `tap`, `throttle`, `thru`, `toArray`,
+`toPairs`, `toPairsIn`, `toPath`, `toPlainObject`, `transform`, `unary`,
+`union`, `unionBy`, `unionWith`, `uniq`, `uniqBy`, `uniqWith`, `unset`,
+`unshift`, `unzip`, `unzipWith`, `update`, `updateWith`, `values`,
+`valuesIn`, `without`, `wrap`, `xor`, `xorBy`, `xorWith`, `zip`,
+`zipObject`, `zipObjectDeep`, and `zipWith`
<br>
<br>
The wrapper methods that are **not** chainable by default are:<br>
`add`, `attempt`, `camelCase`, `capitalize`, `ceil`, `clamp`, `clone`,
-`cloneDeep`, `cloneDeepWith`, `cloneWith`, `deburr`, `endsWith`, `eq`,
-`escape`, `escapeRegExp`, `every`, `find`, `findIndex`, `findKey`, `findLast`,
-`findLastIndex`, `findLastKey`, `floor`, `forEach`, `forEachRight`, `forIn`,
-`forInRight`, `forOwn`, `forOwnRight`, `get`, `gt`, `gte`, `has`, `hasIn`,
-`head`, `identity`, `includes`, `indexOf`, `inRange`, `invoke`, `isArguments`,
-`isArray`, `isArrayBuffer`, `isArrayLike`, `isArrayLikeObject`, `isBoolean`,
-`isBuffer`, `isDate`, `isElement`, `isEmpty`, `isEqual`, `isEqualWith`,
-`isError`, `isFinite`, `isFunction`, `isInteger`, `isLength`, `isMap`,
-`isMatch`, `isMatchWith`, `isNaN`, `isNative`, `isNil`, `isNull`, `isNumber`,
+`cloneDeep`, `cloneDeepWith`, `cloneWith`, `deburr`, `divide`, `each`,
+`eachRight`, `endsWith`, `eq`, `escape`, `escapeRegExp`, `every`, `find`,
+`findIndex`, `findKey`, `findLast`, `findLastIndex`, `findLastKey`, `first`,
+`floor`, `forEach`, `forEachRight`, `forIn`, `forInRight`, `forOwn`,
+`forOwnRight`, `get`, `gt`, `gte`, `has`, `hasIn`, `head`, `identity`,
+`includes`, `indexOf`, `inRange`, `invoke`, `isArguments`, `isArray`,
+`isArrayBuffer`, `isArrayLike`, `isArrayLikeObject`, `isBoolean`, `isBuffer`,
+`isDate`, `isElement`, `isEmpty`, `isEqual`, `isEqualWith`, `isError`,
+`isFinite`, `isFunction`, `isInteger`, `isLength`, `isMap`, `isMatch`,
+`isMatchWith`, `isNaN`, `isNative`, `isNil`, `isNull`, `isNumber`,
`isObject`, `isObjectLike`, `isPlainObject`, `isRegExp`, `isSafeInteger`,
`isSet`, `isString`, `isUndefined`, `isTypedArray`, `isWeakMap`, `isWeakSet`,
`join`, `kebabCase`, `last`, `lastIndexOf`, `lowerCase`, `lowerFirst`,
-`lt`, `lte`, `max`, `maxBy`, `mean`, `min`, `minBy`, `noConflict`, `noop`,
-`now`, `pad`, `padEnd`, `padStart`, `parseInt`, `pop`, `random`, `reduce`,
-`reduceRight`, `repeat`, `result`, `round`, `runInContext`, `sample`,
-`shift`, `size`, `snakeCase`, `some`, `sortedIndex`, `sortedIndexBy`,
-`sortedLastIndex`, `sortedLastIndexBy`, `startCase`, `startsWith`, `subtract`,
-`sum`, `sumBy`, `template`, `times`, `toLower`, `toInteger`, `toLength`,
-`toNumber`, `toSafeInteger`, `toString`, `toUpper`, `trim`, `trimEnd`,
-`trimStart`, `truncate`, `unescape`, `uniqueId`, `upperCase`, `upperFirst`,
-`value`, and `words`
+`lt`, `lte`, `max`, `maxBy`, `mean`, `meanBy`, `min`, `minBy`, `multiply`,
+`noConflict`, `noop`, `now`, `nth`, `pad`, `padEnd`, `padStart`, `parseInt`,
+`pop`, `random`, `reduce`, `reduceRight`, `repeat`, `result`, `round`,
+`runInContext`, `sample`, `shift`, `size`, `snakeCase`, `some`, `sortedIndex`,
+`sortedIndexBy`, `sortedLastIndex`, `sortedLastIndexBy`, `startCase`,
+`startsWith`, `subtract`, `sum`, `sumBy`, `template`, `times`, `toInteger`,
+`toJSON`, `toLength`, `toLower`, `toNumber`, `toSafeInteger`, `toString`,
+`toUpper`, `trim`, `trimEnd`, `trimStart`, `truncate`, `unescape`,
+`uniqueId`, `upperCase`, `upperFirst`, `value`, and `words`
#### Arguments
1. `value` *(*)*: The value to wrap in a `lodash` instance.
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
### <a id="_chainvalue"></a>`_.chain(value)`
-<a href="#_chainvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7205 "View in source") [Ⓣ][1]
+<a href="#_chainvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7876 "View in source") [Ⓣ][1]
-Creates a `lodash` object that wraps `value` with explicit method chaining enabled.
-The result of such method chaining must be unwrapped with `_#value`.
+Creates a `lodash` wrapper instance that wraps `value` with explicit method
+chain sequences enabled. The result of such sequences must be unwrapped
+with `_#value`.
+#### Since
+1.3.0
#### Arguments
1. `value` *(*)*: The value to wrap.
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
### <a id="_tapvalue-interceptor"></a>`_.tap(value, interceptor)`
-<a href="#_tapvalue-interceptor">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7233 "View in source") [Ⓣ][1]
+<a href="#_tapvalue-interceptor">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7905 "View in source") [Ⓣ][1]
This method invokes `interceptor` and returns `value`. The interceptor
-is invoked with one argument; (value). The purpose of this method is to
-"tap into" a method chain in order to modify intermediate results.
+is invoked with one argument; *(value)*. The purpose of this method is to
+"tap into" a method chain sequence in order to modify intermediate results.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: The value to provide to `interceptor`.
2. `interceptor` *(Function)*: The function to invoke.
#### Returns
-*(*)*: Returns `value`.
+*(*)*: Returns `value`.
#### Example
```js
<!-- div -->
### <a id="_thruvalue-interceptor"></a>`_.thru(value, interceptor)`
-<a href="#_thruvalue-interceptor">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7260 "View in source") [Ⓣ][1]
+<a href="#_thruvalue-interceptor">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7933 "View in source") [Ⓣ][1]
This method is like `_.tap` except that it returns the result of `interceptor`.
The purpose of this method is to "pass thru" values replacing intermediate
-results in a method chain.
+results in a method chain sequence.
+#### Since
+3.0.0
#### Arguments
1. `value` *(*)*: The value to provide to `interceptor`.
2. `interceptor` *(Function)*: The function to invoke.
#### Returns
-*(*)*: Returns the result of `interceptor`.
+*(*)*: Returns the result of `interceptor`.
#### Example
```js
<!-- div -->
### <a id="_prototypesymboliterator"></a>`_.prototype[Symbol.iterator]()`
-<a href="#_prototypesymboliterator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7436 "View in source") [Ⓣ][1]
+<a href="#_prototypesymboliterator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8092 "View in source") [Ⓣ][1]
Enables the wrapper to be iterable.
+#### Since
+4.0.0
#### Returns
-*(Object)*: Returns the wrapper object.
+*(Object)*: Returns the wrapper object.
#### Example
```js
<!-- div -->
### <a id="_prototypeatpaths"></a>`_.prototype.at([paths])`
-<a href="#_prototypeatpaths">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7283 "View in source") [Ⓣ][1]
+<a href="#_prototypeatpaths">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L7956 "View in source") [Ⓣ][1]
This method is the wrapper version of `_.at`.
+#### Since
+1.0.0
#### Arguments
-1. `[paths]` *(...(string|string[])*: The property paths of elements to pick, specified individually or in arrays.
+1. `[paths]` *(...(string|string[]))*: The property paths of elements to pick.
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
### <a id="_prototypechain"></a>`_.prototype.chain()`
-<a href="#_prototypechain">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7334 "View in source") [Ⓣ][1]
+<a href="#_prototypechain">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8008 "View in source") [Ⓣ][1]
-Enables explicit method chaining on the wrapper object.
+Creates a `lodash` wrapper instance with explicit method chain sequences enabled.
+#### Since
+0.1.0
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
### <a id="_prototypecommit"></a>`_.prototype.commit()`
-<a href="#_prototypecommit">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7363 "View in source") [Ⓣ][1]
+<a href="#_prototypecommit">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8038 "View in source") [Ⓣ][1]
-Executes the chained sequence and returns the wrapped result.
+Executes the chain sequence and returns the wrapped result.
+#### Since
+3.2.0
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
-### <a id="_prototypeflatmapiteratee_identity"></a>`_.prototype.flatMap([iteratee=_.identity])`
-<a href="#_prototypeflatmapiteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7384 "View in source") [Ⓣ][1]
-
-This method is the wrapper version of `_.flatMap`.
-
-#### Arguments
-1. `[iteratee=_.identity]` *(Function|Object|string)*: The function invoked per iteration.
-
-#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
-
-#### Example
-```js
-function duplicate(n) {
- return [n, n];
-}
-
-_([1, 2]).flatMap(duplicate).value();
-// => [1, 1, 2, 2]
-```
-* * *
-
-<!-- /div -->
-
-<!-- div -->
-
### <a id="_prototypenext"></a>`_.prototype.next()`
-<a href="#_prototypenext">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7409 "View in source") [Ⓣ][1]
+<a href="#_prototypenext">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8064 "View in source") [Ⓣ][1]
Gets the next value on a wrapped object following the
[iterator protocol](https://mdn.io/iteration_protocols#iterator).
+#### Since
+4.0.0
#### Returns
-*(Object)*: Returns the next iterator value.
+*(Object)*: Returns the next iterator value.
#### Example
```js
<!-- div -->
### <a id="_prototypeplantvalue"></a>`_.prototype.plant(value)`
-<a href="#_prototypeplantvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7463 "View in source") [Ⓣ][1]
+<a href="#_prototypeplantvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8120 "View in source") [Ⓣ][1]
-Creates a clone of the chained sequence planting `value` as the wrapped value.
+Creates a clone of the chain sequence planting `value` as the wrapped value.
+#### Since
+3.2.0
#### Arguments
1. `value` *(*)*: The value to plant.
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
### <a id="_prototypereverse"></a>`_.prototype.reverse()`
-<a href="#_prototypereverse">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7502 "View in source") [Ⓣ][1]
+<a href="#_prototypereverse">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8160 "View in source") [Ⓣ][1]
This method is the wrapper version of `_.reverse`.
<br>
<br>
**Note:** This method mutates the wrapped array.
+#### Since
+0.1.0
#### Returns
-*(Object)*: Returns the new `lodash` wrapper instance.
+*(Object)*: Returns the new `lodash` wrapper instance.
#### Example
```js
<!-- div -->
### <a id="_prototypevalue"></a>`_.prototype.value()`
-<a href="#_prototypevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L7533 "View in source") [Ⓣ][1]
+<a href="#_prototypevalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L8192 "View in source") [Ⓣ][1]
-Executes the chained sequence to extract the unwrapped value.
+Executes the chain sequence to resolve the unwrapped value.
+#### Since
+0.1.0
#### Aliases
*_.prototype.toJSON, _.prototype.valueOf*
#### Returns
-*(*)*: Returns the resolved unwrapped value.
+*(*)*: Returns the resolved unwrapped value.
#### Example
```js
<!-- div -->
### <a id="_camelcasestring"></a>`_.camelCase([string=''])`
-<a href="#_camelcasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12228 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.camelcase "See the npm package")
+<a href="#_camelcasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13297 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.camelcase "See the npm package")
Converts `string` to [camel case](https://en.wikipedia.org/wiki/CamelCase).
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the camel cased string.
+*(string)*: Returns the camel cased string.
#### Example
```js
_.camelCase('Foo Bar');
// => 'fooBar'
-_.camelCase('--foo-bar');
+_.camelCase('--foo-bar--');
// => 'fooBar'
-_.camelCase('__foo_bar__');
+_.camelCase('__FOO_BAR__');
// => 'fooBar'
```
* * *
<!-- div -->
### <a id="_capitalizestring"></a>`_.capitalize([string=''])`
-<a href="#_capitalizestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12247 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.capitalize "See the npm package")
+<a href="#_capitalizestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13317 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.capitalize "See the npm package")
Converts the first character of `string` to upper case and the remaining
to lower case.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to capitalize.
#### Returns
-*(string)*: Returns the capitalized string.
+*(string)*: Returns the capitalized string.
#### Example
```js
<!-- div -->
### <a id="_deburrstring"></a>`_.deburr([string=''])`
-<a href="#_deburrstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12265 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.deburr "See the npm package")
+<a href="#_deburrstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13338 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.deburr "See the npm package")
-Deburrs `string` by converting [latin-1 supplementary letters](https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table)
-to basic latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
+Deburrs `string` by converting
+[latin-1 supplementary letters](https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table)
+to basic latin letters and removing
+[combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to deburr.
#### Returns
-*(string)*: Returns the deburred string.
+*(string)*: Returns the deburred string.
#### Example
```js
<!-- div -->
### <a id="_endswithstring-target-positionstringlength"></a>`_.endsWith([string=''], [target], [position=string.length])`
-<a href="#_endswithstring-target-positionstringlength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12291 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.endswith "See the npm package")
+<a href="#_endswithstring-target-positionstringlength">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13366 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.endswith "See the npm package")
Checks if `string` ends with the given target string.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to search.
2. `[target]` *(string)*: The string to search for.
3. `[position=string.length]` *(number)*: The position to search from.
#### Returns
-*(boolean)*: Returns `true` if `string` ends with `target`, else `false`.
+*(boolean)*: Returns `true` if `string` ends with `target`, else `false`.
#### Example
```js
<!-- div -->
### <a id="_escapestring"></a>`_.escape([string=''])`
-<a href="#_escapestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12336 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.escape "See the npm package")
+<a href="#_escapestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13413 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.escape "See the npm package")
Converts the characters "&", "<", ">", '"', "'", and "\`" in `string` to
their corresponding HTML entities.
<br>
Though the ">" character is escaped for symmetry, characters like
">" and "/" don't need escaping in HTML and have no special meaning
-unless they're part of a tag or unquoted attribute value.
-See [Mathias Bynens's article](https://mathiasbynens.be/notes/ambiguous-ampersands)
-(under "semi-related fun fact") for more details.
+unless they're part of a tag or unquoted attribute value. See
+[Mathias Bynens's article](https://mathiasbynens.be/notes/ambiguous-ampersands)
+*(under "semi-related fun fact")* for more details.
<br>
<br>
-Backticks are escaped because in IE < 9, they can break out of
+Backticks are escaped because in IE < `9`, they can break out of
attribute values or HTML comments. See [#59](https://html5sec.org/#59),
[#102](https://html5sec.org/#102), [#108](https://html5sec.org/#108), and
-[#133](https://html5sec.org/#133) of the [HTML5 Security Cheatsheet](https://html5sec.org/)
-for more details.
+[#133](https://html5sec.org/#133) of the
+[HTML5 Security Cheatsheet](https://html5sec.org/) for more details.
<br>
<br>
-When working with HTML you should always [quote attribute values](http://wonko.com/post/html-escaping)
-to reduce XSS vectors.
+When working with HTML you should always
+[quote attribute values](http://wonko.com/post/html-escaping) to reduce
+XSS vectors.
+#### Since
+0.1.0
#### Arguments
1. `[string='']` *(string)*: The string to escape.
#### Returns
-*(string)*: Returns the escaped string.
+*(string)*: Returns the escaped string.
#### Example
```js
<!-- div -->
### <a id="_escaperegexpstring"></a>`_.escapeRegExp([string=''])`
-<a href="#_escaperegexpstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12357 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.escaperegexp "See the npm package")
+<a href="#_escaperegexpstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13435 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.escaperegexp "See the npm package")
Escapes the `RegExp` special characters "^", "$", "\", ".", "*", "+",
"?", "(", ")", "[", "]", "{", "}", and "|" in `string`.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to escape.
#### Returns
-*(string)*: Returns the escaped string.
+*(string)*: Returns the escaped string.
#### Example
```js
<!-- div -->
### <a id="_kebabcasestring"></a>`_.kebabCase([string=''])`
-<a href="#_kebabcasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12383 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.kebabcase "See the npm package")
+<a href="#_kebabcasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13463 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.kebabcase "See the npm package")
-Converts `string` to [kebab case](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles).
+Converts `string` to
+[kebab case](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles).
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the kebab cased string.
+*(string)*: Returns the kebab cased string.
#### Example
```js
_.kebabCase('fooBar');
// => 'foo-bar'
-_.kebabCase('__foo_bar__');
+_.kebabCase('__FOO_BAR__');
// => 'foo-bar'
```
* * *
<!-- div -->
### <a id="_lowercasestring"></a>`_.lowerCase([string=''])`
-<a href="#_lowercasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12406 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lowercase "See the npm package")
+<a href="#_lowercasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13487 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lowercase "See the npm package")
Converts `string`, as space separated words, to lower case.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the lower cased string.
+*(string)*: Returns the lower cased string.
#### Example
```js
-_.lowerCase('--Foo-Bar');
+_.lowerCase('--Foo-Bar--');
// => 'foo bar'
_.lowerCase('fooBar');
<!-- div -->
### <a id="_lowerfirststring"></a>`_.lowerFirst([string=''])`
-<a href="#_lowerfirststring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12426 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lowerfirst "See the npm package")
+<a href="#_lowerfirststring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13508 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.lowerfirst "See the npm package")
Converts the first character of `string` to lower case.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the converted string.
+*(string)*: Returns the converted string.
#### Example
```js
<!-- div -->
### <a id="_padstring-length0-chars"></a>`_.pad([string=''], [length=0], [chars=' '])`
-<a href="#_padstring-length0-chars">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12468 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pad "See the npm package")
+<a href="#_padstring-length0-chars">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13533 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.pad "See the npm package")
Pads `string` on the left and right sides if it's shorter than `length`.
Padding characters are truncated if they can't be evenly divided by `length`.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to pad.
2. `[length=0]` *(number)*: The padding length.
3. `[chars=' ']` *(string)*: The string used as padding.
#### Returns
-*(string)*: Returns the padded string.
+*(string)*: Returns the padded string.
#### Example
```js
<!-- div -->
### <a id="_padendstring-length0-chars"></a>`_.padEnd([string=''], [length=0], [chars=' '])`
-<a href="#_padendstring-length0-chars">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12505 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.padend "See the npm package")
+<a href="#_padendstring-length0-chars">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13572 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.padend "See the npm package")
Pads `string` on the right side if it's shorter than `length`. Padding
characters are truncated if they exceed `length`.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to pad.
2. `[length=0]` *(number)*: The padding length.
3. `[chars=' ']` *(string)*: The string used as padding.
#### Returns
-*(string)*: Returns the padded string.
+*(string)*: Returns the padded string.
#### Example
```js
<!-- div -->
### <a id="_padstartstring-length0-chars"></a>`_.padStart([string=''], [length=0], [chars=' '])`
-<a href="#_padstartstring-length0-chars">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12532 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.padstart "See the npm package")
+<a href="#_padstartstring-length0-chars">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13605 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.padstart "See the npm package")
Pads `string` on the left side if it's shorter than `length`. Padding
characters are truncated if they exceed `length`.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to pad.
2. `[length=0]` *(number)*: The padding length.
3. `[chars=' ']` *(string)*: The string used as padding.
#### Returns
-*(string)*: Returns the padded string.
+*(string)*: Returns the padded string.
#### Example
```js
<!-- div -->
### <a id="_parseintstring-radix10"></a>`_.parseInt(string, [radix=10])`
-<a href="#_parseintstring-radix10">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12560 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.parseint "See the npm package")
+<a href="#_parseintstring-radix10">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13639 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.parseint "See the npm package")
Converts `string` to an integer of the specified radix. If `radix` is
-`undefined` or `0`, a `radix` of `10` is used unless `value` is a hexadecimal,
-in which case a `radix` of `16` is used.
+`undefined` or `0`, a `radix` of `10` is used unless `value` is a
+hexadecimal, in which case a `radix` of `16` is used.
<br>
<br>
-**Note:** This method aligns with the [ES5 implementation](https://es5.github.io/#x15.1.2.2)
-of `parseInt`.
+**Note:** This method aligns with the
+[ES5 implementation](https://es5.github.io/#x15.1.2.2) of `parseInt`.
+#### Since
+1.1.0
#### Arguments
1. `string` *(string)*: The string to convert.
2. `[radix=10]` *(number)*: The radix to interpret `value` by.
#### Returns
-*(number)*: Returns the converted integer.
+*(number)*: Returns the converted integer.
#### Example
```js
<!-- div -->
-### <a id="_repeatstring-n0"></a>`_.repeat([string=''], [n=0])`
-<a href="#_repeatstring-n0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12592 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.repeat "See the npm package")
+### <a id="_repeatstring-n1"></a>`_.repeat([string=''], [n=1])`
+<a href="#_repeatstring-n1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13673 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.repeat "See the npm package")
Repeats the given string `n` times.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to repeat.
-2. `[n=0]` *(number)*: The number of times to repeat the string.
+2. `[n=1]` *(number)*: The number of times to repeat the string.
#### Returns
-*(string)*: Returns the repeated string.
+*(string)*: Returns the repeated string.
#### Example
```js
<!-- div -->
### <a id="_replacestring-pattern-replacement"></a>`_.replace([string=''], pattern, replacement)`
-<a href="#_replacestring-pattern-replacement">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12630 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.replace "See the npm package")
+<a href="#_replacestring-pattern-replacement">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13701 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.replace "See the npm package")
Replaces matches for `pattern` in `string` with `replacement`.
<br>
<br>
-**Note:** This method is based on [`String#replace`](https://mdn.io/String/replace).
+**Note:** This method is based on
+[`String#replace`](https://mdn.io/String/replace).
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to modify.
2. `pattern` *(RegExp|string)*: The pattern to replace.
3. `replacement` *(Function|string)*: The match replacement.
#### Returns
-*(string)*: Returns the modified string.
+*(string)*: Returns the modified string.
#### Example
```js
<!-- div -->
### <a id="_snakecasestring"></a>`_.snakeCase([string=''])`
-<a href="#_snakecasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12656 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.snakecase "See the npm package")
+<a href="#_snakecasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13729 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.snakecase "See the npm package")
-Converts `string` to [snake case](https://en.wikipedia.org/wiki/Snake_case).
+Converts `string` to
+[snake case](https://en.wikipedia.org/wiki/Snake_case).
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the snake cased string.
+*(string)*: Returns the snake cased string.
#### Example
```js
_.snakeCase('fooBar');
// => 'foo_bar'
-_.snakeCase('--foo-bar');
+_.snakeCase('--FOO-BAR--');
// => 'foo_bar'
```
* * *
<!-- div -->
### <a id="_splitstring-separator-limit"></a>`_.split([string=''], separator, [limit])`
-<a href="#_splitstring-separator-limit">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12677 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.split "See the npm package")
+<a href="#_splitstring-separator-limit">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13752 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.split "See the npm package")
Splits `string` by `separator`.
<br>
<br>
-**Note:** This method is based on [`String#split`](https://mdn.io/String/split).
+**Note:** This method is based on
+[`String#split`](https://mdn.io/String/split).
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to split.
2. `separator` *(RegExp|string)*: The separator pattern to split by.
3. `[limit]` *(number)*: The length to truncate results to.
#### Returns
-*(Array)*: Returns the new array of string segments.
+*(Array)*: Returns the new array of string segments.
#### Example
```js
<!-- div -->
### <a id="_startcasestring"></a>`_.startCase([string=''])`
-<a href="#_startcasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12700 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.startcase "See the npm package")
+<a href="#_startcasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13794 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.startcase "See the npm package")
-Converts `string` to [start case](https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage).
+Converts `string` to
+[start case](https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage).
+#### Since
+3.1.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the start cased string.
+*(string)*: Returns the start cased string.
#### Example
```js
-_.startCase('--foo-bar');
+_.startCase('--foo-bar--');
// => 'Foo Bar'
_.startCase('fooBar');
// => 'Foo Bar'
-_.startCase('__foo_bar__');
-// => 'Foo Bar'
+_.startCase('__FOO_BAR__');
+// => 'FOO BAR'
```
* * *
<!-- div -->
### <a id="_startswithstring-target-position0"></a>`_.startsWith([string=''], [target], [position=0])`
-<a href="#_startswithstring-target-position0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12725 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.startswith "See the npm package")
+<a href="#_startswithstring-target-position0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13821 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.startswith "See the npm package")
Checks if `string` starts with the given target string.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to search.
2. `[target]` *(string)*: The string to search for.
3. `[position=0]` *(number)*: The position to search from.
#### Returns
-*(boolean)*: Returns `true` if `string` starts with `target`, else `false`.
+*(boolean)*: Returns `true` if `string` starts with `target`, else `false`.
#### Example
```js
<!-- div -->
-### <a id="_templatestring-options"></a>`_.template([string=''], [options])`
-<a href="#_templatestring-options">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12827 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.template "See the npm package")
+### <a id="_templatestring-options-optionsescape_templatesettingsescape-optionsevaluate_templatesettingsevaluate-optionsimports_templatesettingsimports-optionsinterpolate_templatesettingsinterpolate-optionssourceurllodashtemplatesourcesn-optionsvariableobj"></a>`_.template([string=''], [options={}], [options.escape=_.templateSettings.escape], [options.evaluate=_.templateSettings.evaluate], [options.imports=_.templateSettings.imports], [options.interpolate=_.templateSettings.interpolate], [options.sourceURL='lodash.templateSources[n]'], [options.variable='obj'])`
+<a href="#_templatestring-options-optionsescape_templatesettingsescape-optionsevaluate_templatesettingsevaluate-optionsimports_templatesettingsimports-optionsinterpolate_templatesettingsinterpolate-optionssourceurllodashtemplatesourcesn-optionsvariableobj">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L13930 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.template "See the npm package")
Creates a compiled template function that can interpolate data properties
in "interpolate" delimiters, HTML-escape interpolated data properties in
"escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data
properties may be accessed as free variables in the template. If a setting
-object is given it takes precedence over `_.templateSettings` values.
+object is given, it takes precedence over `_.templateSettings` values.
<br>
<br>
**Note:** In the development build `_.template` utilizes
For more information on Chrome extension sandboxes see
[Chrome's extensions documentation](https://developer.chrome.com/extensions/sandboxingEval).
+#### Since
+0.1.0
#### Arguments
1. `[string='']` *(string)*: The template string.
-2. `[options]` *(Object)*: The options object.
-3. `[options.escape]` *(RegExp)*: The HTML "escape" delimiter.
-4. `[options.evaluate]` *(RegExp)*: The "evaluate" delimiter.
-5. `[options.imports]` *(Object)*: An object to import into the template as free variables.
-6. `[options.interpolate]` *(RegExp)*: The "interpolate" delimiter.
-7. `[options.sourceURL]` *(string)*: The sourceURL of the template's compiled source.
-8. `[options.variable]` *(string)*: The data object variable name.
+2. `[options={}]` *(Object)*: The options object.
+3. `[options.escape=_.templateSettings.escape]` *(RegExp)*: The HTML "escape" delimiter.
+4. `[options.evaluate=_.templateSettings.evaluate]` *(RegExp)*: The "evaluate" delimiter.
+5. `[options.imports=_.templateSettings.imports]` *(Object)*: An object to import into the template as free variables.
+6. `[options.interpolate=_.templateSettings.interpolate]` *(RegExp)*: The "interpolate" delimiter.
+7. `[options.sourceURL='lodash.templateSources[n]']` *(string)*: The sourceURL of the compiled template.
+8. `[options.variable='obj']` *(string)*: The data object variable name.
#### Returns
-*(Function)*: Returns the compiled template function.
+*(Function)*: Returns the compiled template function.
#### Example
```js
// Use the `sourceURL` option to specify a custom sourceURL for the template.
var compiled = _.template('hello <%= user %>!', { 'sourceURL': '/basic/greeting.jst' });
compiled(data);
-// => find the source of "greeting.jst" under the Sources tab or Resources panel of the web inspector
+// => Find the source of "greeting.jst" under the Sources tab or Resources panel of the web inspector.
// Use the `variable` option to ensure a with-statement isn't used in the compiled template.
var compiled = _.template('hi <%= data.user %>!', { 'variable': 'data' });
<!-- div -->
### <a id="_tolowerstring"></a>`_.toLower([string=''])`
-<a href="#_tolowerstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12953 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tolower "See the npm package")
+<a href="#_tolowerstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14059 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.tolower "See the npm package")
-Converts `string`, as a whole, to lower case.
+Converts `string`, as a whole, to lower case just like
+[String#toLowerCase](https://mdn.io/toLowerCase).
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the lower cased string.
+*(string)*: Returns the lower cased string.
#### Example
```js
-_.toLower('--Foo-Bar');
-// => '--foo-bar'
+_.toLower('--Foo-Bar--');
+// => '--foo-bar--'
_.toLower('fooBar');
// => 'foobar'
<!-- div -->
### <a id="_toupperstring"></a>`_.toUpper([string=''])`
-<a href="#_toupperstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12976 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.toupper "See the npm package")
+<a href="#_toupperstring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14084 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.toupper "See the npm package")
-Converts `string`, as a whole, to upper case.
+Converts `string`, as a whole, to upper case just like
+[String#toUpperCase](https://mdn.io/toUpperCase).
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the upper cased string.
+*(string)*: Returns the upper cased string.
#### Example
```js
-_.toUpper('--foo-bar');
-// => '--FOO-BAR'
+_.toUpper('--foo-bar--');
+// => '--FOO-BAR--'
_.toUpper('fooBar');
// => 'FOOBAR'
<!-- div -->
### <a id="_trimstring-charswhitespace"></a>`_.trim([string=''], [chars=whitespace])`
-<a href="#_trimstring-charswhitespace">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13001 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.trim "See the npm package")
+<a href="#_trimstring-charswhitespace">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14110 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.trim "See the npm package")
Removes leading and trailing whitespace or specified characters from `string`.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to trim.
2. `[chars=whitespace]` *(string)*: The characters to trim.
#### Returns
-*(string)*: Returns the trimmed string.
+*(string)*: Returns the trimmed string.
#### Example
```js
<!-- div -->
### <a id="_trimendstring-charswhitespace"></a>`_.trimEnd([string=''], [chars=whitespace])`
-<a href="#_trimendstring-charswhitespace">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13039 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.trimend "See the npm package")
+<a href="#_trimendstring-charswhitespace">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14145 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.trimend "See the npm package")
Removes trailing whitespace or specified characters from `string`.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to trim.
2. `[chars=whitespace]` *(string)*: The characters to trim.
#### Returns
-*(string)*: Returns the trimmed string.
+*(string)*: Returns the trimmed string.
#### Example
```js
<!-- div -->
### <a id="_trimstartstring-charswhitespace"></a>`_.trimStart([string=''], [chars=whitespace])`
-<a href="#_trimstartstring-charswhitespace">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13075 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.trimstart "See the npm package")
+<a href="#_trimstartstring-charswhitespace">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14178 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.trimstart "See the npm package")
Removes leading whitespace or specified characters from `string`.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to trim.
2. `[chars=whitespace]` *(string)*: The characters to trim.
#### Returns
-*(string)*: Returns the trimmed string.
+*(string)*: Returns the trimmed string.
#### Example
```js
<!-- div -->
-### <a id="_truncatestring-options-optionslength30-optionsomission-optionsseparator"></a>`_.truncate([string=''], [options=({})], [options.length=30], [options.omission='...'], [options.separator])`
-<a href="#_truncatestring-options-optionslength30-optionsomission-optionsseparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13129 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.truncate "See the npm package")
+### <a id="_truncatestring-options-optionslength30-optionsomission-optionsseparator"></a>`_.truncate([string=''], [options={}], [options.length=30], [options.omission='...'], [options.separator])`
+<a href="#_truncatestring-options-optionslength30-optionsomission-optionsseparator">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14229 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.truncate "See the npm package")
Truncates `string` if it's longer than the given maximum string length.
The last characters of the truncated string are replaced with the omission
string which defaults to "...".
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to truncate.
-2. `[options=({})]` *(Object)*: The options object.
+2. `[options={}]` *(Object)*: The options object.
3. `[options.length=30]` *(number)*: The maximum string length.
4. `[options.omission='...']` *(string)*: The string to indicate text is omitted.
5. `[options.separator]` *(RegExp|string)*: The separator pattern to truncate to.
#### Returns
-*(string)*: Returns the truncated string.
+*(string)*: Returns the truncated string.
#### Example
```js
<!-- div -->
### <a id="_unescapestring"></a>`_.unescape([string=''])`
-<a href="#_unescapestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13203 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unescape "See the npm package")
+<a href="#_unescapestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14304 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.unescape "See the npm package")
The inverse of `_.escape`; this method converts the HTML entities
-`&`, `<`, `>`, `"`, `'`, and ``` in `string` to their
-corresponding characters.
+`&`, `<`, `>`, `"`, `'`, and ``` in `string` to
+their corresponding characters.
<br>
<br>
-**Note:** No other HTML entities are unescaped. To unescape additional HTML
-entities use a third-party library like [_he_](https://mths.be/he).
+**Note:** No other HTML entities are unescaped. To unescape additional
+HTML entities use a third-party library like [_he_](https://mths.be/he).
+#### Since
+0.6.0
#### Arguments
1. `[string='']` *(string)*: The string to unescape.
#### Returns
-*(string)*: Returns the unescaped string.
+*(string)*: Returns the unescaped string.
#### Example
```js
<!-- div -->
### <a id="_uppercasestring"></a>`_.upperCase([string=''])`
-<a href="#_uppercasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13229 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uppercase "See the npm package")
+<a href="#_uppercasestring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14331 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uppercase "See the npm package")
Converts `string`, as space separated words, to upper case.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the upper cased string.
+*(string)*: Returns the upper cased string.
#### Example
```js
<!-- div -->
### <a id="_upperfirststring"></a>`_.upperFirst([string=''])`
-<a href="#_upperfirststring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L12444 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.upperfirst "See the npm package")
+<a href="#_upperfirststring">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14352 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.upperfirst "See the npm package")
Converts the first character of `string` to upper case.
+#### Since
+4.0.0
#### Arguments
1. `[string='']` *(string)*: The string to convert.
#### Returns
-*(string)*: Returns the converted string.
+*(string)*: Returns the converted string.
#### Example
```js
<!-- div -->
### <a id="_wordsstring-pattern"></a>`_.words([string=''], [pattern])`
-<a href="#_wordsstring-pattern">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13251 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.words "See the npm package")
+<a href="#_wordsstring-pattern">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14373 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.words "See the npm package")
Splits `string` into an array of its words.
+#### Since
+3.0.0
#### Arguments
1. `[string='']` *(string)*: The string to inspect.
2. `[pattern]` *(RegExp|string)*: The pattern to match words.
#### Returns
-*(Array)*: Returns the words of `string`.
+*(Array)*: Returns the words of `string`.
#### Example
```js
<!-- div -->
-### <a id="_attemptfunc"></a>`_.attempt(func)`
-<a href="#_attemptfunc">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13283 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.attempt "See the npm package")
+### <a id="_attemptfunc-args"></a>`_.attempt(func, [args])`
+<a href="#_attemptfunc-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14407 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.attempt "See the npm package")
Attempts to invoke `func`, returning either the result or the caught error
object. Any additional arguments are provided to `func` when it's invoked.
+#### Since
+3.0.0
#### Arguments
1. `func` *(Function)*: The function to attempt.
+2. `[args]` *(...*)*: The arguments to invoke `func` with.
#### Returns
-*(*)*: Returns the `func` result or error object.
+*(*)*: Returns the `func` result or error object.
#### Example
```js
<!-- div -->
### <a id="_bindallobject-methodnames"></a>`_.bindAll(object, methodNames)`
-<a href="#_bindallobject-methodnames">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13317 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.bindall "See the npm package")
+<a href="#_bindallobject-methodnames">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14441 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.bindall "See the npm package")
Binds methods of an object to the object itself, overwriting the existing
method.
<br>
**Note:** This method doesn't set the "length" property of bound functions.
+#### Since
+0.1.0
#### Arguments
1. `object` *(Object)*: The object to bind and assign the bound methods to.
-2. `methodNames` *(...(string|string[])*: The object method names to bind, specified individually or in arrays.
+2. `methodNames` *(...(string|string[]))*: The object method names to bind.
#### Returns
-*(Object)*: Returns `object`.
+*(Object)*: Returns `object`.
#### Example
```js
_.bindAll(view, 'onClick');
jQuery(element).on('click', view.onClick);
-// => logs 'clicked docs' when clicked
+// => Logs 'clicked docs' when clicked.
```
* * *
<!-- div -->
### <a id="_condpairs"></a>`_.cond(pairs)`
-<a href="#_condpairs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13352 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.cond "See the npm package")
+<a href="#_condpairs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14478 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.cond "See the npm package")
-Creates a function that iterates over `pairs` invoking the corresponding
+Creates a function that iterates over `pairs` and invokes the corresponding
function of the first predicate to return truthy. The predicate-function
pairs are invoked with the `this` binding and arguments of the created
function.
+#### Since
+4.0.0
#### Arguments
1. `pairs` *(Array)*: The predicate-function pairs.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_conformssource"></a>`_.conforms(source)`
-<a href="#_conformssource">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13394 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.conforms "See the npm package")
+<a href="#_conformssource">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14521 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.conforms "See the npm package")
Creates a function that invokes the predicate properties of `source` with
the corresponding property values of a given object, returning `true` if
all predicates return truthy, else `false`.
+#### Since
+4.0.0
#### Arguments
1. `source` *(Object)*: The object of property predicates to conform to.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_constantvalue"></a>`_.constant(value)`
-<a href="#_constantvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13414 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.constant "See the npm package")
+<a href="#_constantvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14542 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.constant "See the npm package")
Creates a function that returns `value`.
+#### Since
+2.4.0
#### Arguments
1. `value` *(*)*: The value to return from the new function.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_flowfuncs"></a>`_.flow([funcs])`
-<a href="#_flowfuncs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13440 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flow "See the npm package")
+<a href="#_flowfuncs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14570 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flow "See the npm package")
Creates a function that returns the result of invoking the given functions
with the `this` binding of the created function, where each successive
invocation is supplied the return value of the previous.
+#### Since
+3.0.0
#### Arguments
-1. `[funcs]` *(...(Function|Function[])*: Functions to invoke.
+1. `[funcs]` *(...(Function|Function[]))*: Functions to invoke.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_flowrightfuncs"></a>`_.flowRight([funcs])`
-<a href="#_flowrightfuncs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13461 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flowright "See the npm package")
+<a href="#_flowrightfuncs">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14593 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.flowright "See the npm package")
This method is like `_.flow` except that it creates a function that
invokes the given functions from right to left.
+#### Since
+3.0.0
#### Arguments
-1. `[funcs]` *(...(Function|Function[])*: Functions to invoke.
+1. `[funcs]` *(...(Function|Function[]))*: Functions to invoke.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_identityvalue"></a>`_.identity(value)`
-<a href="#_identityvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13478 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.identity "See the npm package")
+<a href="#_identityvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14611 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.identity "See the npm package")
This method returns the first argument given to it.
+#### Since
+0.1.0
#### Arguments
1. `value` *(*)*: Any value.
#### Returns
-*(*)*: Returns `value`.
+*(*)*: Returns `value`.
#### Example
```js
<!-- div -->
### <a id="_iterateefunc_identity"></a>`_.iteratee([func=_.identity])`
-<a href="#_iterateefunc_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13512 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.iteratee "See the npm package")
+<a href="#_iterateefunc_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14657 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.iteratee "See the npm package")
Creates a function that invokes `func` with the arguments of the created
-function. If `func` is a property name the created callback returns the
-property value for a given element. If `func` is an object the created
-callback returns `true` for elements that contain the equivalent object
-properties, otherwise it returns `false`.
+function. If `func` is a property name, the created function returns the
+property value for a given element. If `func` is an array or object, the
+created function returns `true` for elements that contain the equivalent
+source properties, otherwise it returns `false`.
+#### Since
+4.0.0
#### Arguments
1. `[func=_.identity]` *(*)*: The value to convert to a callback.
#### Returns
-*(Function)*: Returns the callback.
+*(Function)*: Returns the callback.
#### Example
```js
var users = [
- { 'user': 'barney', 'age': 36 },
- { 'user': 'fred', 'age': 40 }
+ { 'user': 'barney', 'age': 36, 'active': true },
+ { 'user': 'fred', 'age': 40, 'active': false }
];
+// The `_.matches` iteratee shorthand.
+_.filter(users, _.iteratee({ 'user': 'barney', 'active': true }));
+// => [{ 'user': 'barney', 'age': 36, 'active': true }]
+
+// The `_.matchesProperty` iteratee shorthand.
+_.filter(users, _.iteratee(['user', 'fred']));
+// => [{ 'user': 'fred', 'age': 40 }]
+
+// The `_.property` iteratee shorthand.
+_.map(users, _.iteratee('user'));
+// => ['barney', 'fred']
+
// Create custom iteratee shorthands.
-_.iteratee = _.wrap(_.iteratee, function(callback, func) {
- var p = /^(\S+)\s*([<>])\s*(\S+)$/.exec(func);
- return !p ? callback(func) : function(object) {
- return (p[2] == '>' ? object[p[1]] > p[3] : object[p[1]] < p[3]);
+_.iteratee = _.wrap(_.iteratee, function(iteratee, func) {
+ return !_.isRegExp(func) ? iteratee(func) : function(string) {
+ return func.test(string);
};
});
-_.filter(users, 'age > 36');
-// => [{ 'user': 'fred', 'age': 40 }]
+_.filter(['abc', 'def'], /ef/);
+// => ['def']
```
* * *
<!-- div -->
### <a id="_matchessource"></a>`_.matches(source)`
-<a href="#_matchessource">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13539 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.matches "See the npm package")
+<a href="#_matchessource">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14685 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.matches "See the npm package")
Creates a function that performs a partial deep comparison between a given
object and `source`, returning `true` if the given object has equivalent
<br>
**Note:** This method supports comparing the same values as `_.isEqual`.
+#### Since
+3.0.0
#### Arguments
1. `source` *(Object)*: The object of property values to match.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_matchespropertypath-srcvalue"></a>`_.matchesProperty(path, srcValue)`
-<a href="#_matchespropertypath-srcvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13566 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.matchesproperty "See the npm package")
+<a href="#_matchespropertypath-srcvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14713 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.matchesproperty "See the npm package")
Creates a function that performs a partial deep comparison between the
value at `path` of a given object to `srcValue`, returning `true` if the
<br>
**Note:** This method supports comparing the same values as `_.isEqual`.
+#### Since
+3.2.0
#### Arguments
1. `path` *(Array|string)*: The path of the property to get.
2. `srcValue` *(*)*: The value to match.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_methodpath-args"></a>`_.method(path, [args])`
-<a href="#_methodpath-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13593 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.method "See the npm package")
+<a href="#_methodpath-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14741 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.method "See the npm package")
Creates a function that invokes the method at `path` of a given object.
Any additional arguments are provided to the invoked method.
+#### Since
+3.7.0
#### Arguments
1. `path` *(Array|string)*: The path of the method to invoke.
2. `[args]` *(...*)*: The arguments to invoke the method with.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
var objects = [
- { 'a': { 'b': { 'c': _.constant(2) } } },
- { 'a': { 'b': { 'c': _.constant(1) } } }
+ { 'a': { 'b': _.constant(2) } },
+ { 'a': { 'b': _.constant(1) } }
];
-_.map(objects, _.method('a.b.c'));
+_.map(objects, _.method('a.b'));
// => [2, 1]
-_.invokeMap(_.sortBy(objects, _.method(['a', 'b', 'c'])), 'a.b.c');
-// => [1, 2]
+_.map(objects, _.method(['a', 'b']));
+// => [2, 1]
```
* * *
<!-- div -->
### <a id="_methodofobject-args"></a>`_.methodOf(object, [args])`
-<a href="#_methodofobject-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13621 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.methodof "See the npm package")
+<a href="#_methodofobject-args">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14770 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.methodof "See the npm package")
The opposite of `_.method`; this method creates a function that invokes
the method at a given path of `object`. Any additional arguments are
provided to the invoked method.
+#### Since
+3.7.0
#### Arguments
1. `object` *(Object)*: The object to query.
2. `[args]` *(...*)*: The arguments to invoke the method with.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
-### <a id="_mixinobjectlodash-source-options"></a>`_.mixin([object=lodash], source, [options])`
-<a href="#_mixinobjectlodash-source-options">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13663 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mixin "See the npm package")
+### <a id="_mixinobjectlodash-source-options-optionschaintrue"></a>`_.mixin([object=lodash], source, [options={}], [options.chain=true])`
+<a href="#_mixinobjectlodash-source-options-optionschaintrue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14812 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.mixin "See the npm package")
-Adds all own enumerable function properties of a source object to the
-destination object. If `object` is a function then methods are added to
-its prototype as well.
+Adds all own enumerable string keyed function properties of a source
+object to the destination object. If `object` is a function, then methods
+are added to its prototype as well.
<br>
<br>
**Note:** Use `_.runInContext` to create a pristine `lodash` function to
avoid conflicts caused by modifying the original.
+#### Since
+0.1.0
#### Arguments
1. `[object=lodash]` *(Function|Object)*: The destination object.
2. `source` *(Object)*: The object of functions to add.
-3. `[options]` *(Object)*: The options object.
-4. `[options.chain=true]` *(boolean)*: Specify whether the functions added are chainable.
+3. `[options={}]` *(Object)*: The options object.
+4. `[options.chain=true]` *(boolean)*: Specify whether mixins are chainable.
#### Returns
-*(Function|Object)*: Returns `object`.
+*(*)*: Returns `object`.
#### Example
```js
<!-- div -->
### <a id="_noconflict"></a>`_.noConflict()`
-<a href="#_noconflict">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13711 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.noconflict "See the npm package")
+<a href="#_noconflict">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14861 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.noconflict "See the npm package")
Reverts the `_` variable to its previous value and returns a reference to
the `lodash` function.
+#### Since
+0.1.0
#### Returns
-*(Function)*: Returns the `lodash` function.
+*(Function)*: Returns the `lodash` function.
#### Example
```js
<!-- div -->
### <a id="_noop"></a>`_.noop()`
-<a href="#_noop">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13732 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.noop "See the npm package")
+<a href="#_noop">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14883 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.noop "See the npm package")
A no-operation function that returns `undefined` regardless of the
arguments it receives.
+#### Since
+2.3.0
#### Example
```js
var object = { 'user': 'fred' };
<!-- div -->
### <a id="_nthargn0"></a>`_.nthArg([n=0])`
-<a href="#_nthargn0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13751 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ntharg "See the npm package")
+<a href="#_nthargn0">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14907 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.ntharg "See the npm package")
-Creates a function that returns its nth argument.
+Creates a function that returns its nth argument. If `n` is negative,
+the nth argument from the end is returned.
+#### Since
+4.0.0
#### Arguments
1. `[n=0]` *(number)*: The index of the argument to return.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
var func = _.nthArg(1);
-
-func('a', 'b', 'c');
+func('a', 'b', 'c', 'd');
// => 'b'
+
+var func = _.nthArg(-2);
+func('a', 'b', 'c', 'd');
+// => 'c'
```
* * *
<!-- div -->
-### <a id="_overiteratees"></a>`_.over(iteratees)`
-<a href="#_overiteratees">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13774 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.over "See the npm package")
+### <a id="_overiteratees_identity"></a>`_.over([iteratees=[_.identity]])`
+<a href="#_overiteratees_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14932 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.over "See the npm package")
-Creates a function that invokes `iteratees` with the arguments provided
-to the created function and returns their results.
+Creates a function that invokes `iteratees` with the arguments it receives
+and returns their results.
+#### Since
+4.0.0
#### Arguments
-1. `iteratees` *(...(Function|Function[])*: The iteratees to invoke.
+1. `[iteratees=[_.identity]]` *(...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[]))*: The iteratees to invoke.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
-### <a id="_overeverypredicates"></a>`_.overEvery(predicates)`
-<a href="#_overeverypredicates">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13798 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.overevery "See the npm package")
+### <a id="_overeverypredicates_identity"></a>`_.overEvery([predicates=[_.identity]])`
+<a href="#_overeverypredicates_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14958 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.overevery "See the npm package")
Creates a function that checks if **all** of the `predicates` return
-truthy when invoked with the arguments provided to the created function.
+truthy when invoked with the arguments it receives.
+#### Since
+4.0.0
#### Arguments
-1. `predicates` *(...(Function|Function[])*: The predicates to check.
+1. `[predicates=[_.identity]]` *(...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[]))*: The predicates to check.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
-### <a id="_oversomepredicates"></a>`_.overSome(predicates)`
-<a href="#_oversomepredicates">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13822 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.oversome "See the npm package")
+### <a id="_oversomepredicates_identity"></a>`_.overSome([predicates=[_.identity]])`
+<a href="#_oversomepredicates_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L14984 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.oversome "See the npm package")
Creates a function that checks if **any** of the `predicates` return
-truthy when invoked with the arguments provided to the created function.
+truthy when invoked with the arguments it receives.
+#### Since
+4.0.0
#### Arguments
-1. `predicates` *(...(Function|Function[])*: The predicates to check.
+1. `[predicates=[_.identity]]` *(...(Array|Array[]|Function|Function[]|Object|Object[]|string|string[]))*: The predicates to check.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_propertypath"></a>`_.property(path)`
-<a href="#_propertypath">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13845 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.property "See the npm package")
+<a href="#_propertypath">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15008 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.property "See the npm package")
Creates a function that returns the value at `path` of a given object.
+#### Since
+2.4.0
#### Arguments
1. `path` *(Array|string)*: The path of the property to get.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
var objects = [
- { 'a': { 'b': { 'c': 2 } } },
- { 'a': { 'b': { 'c': 1 } } }
+ { 'a': { 'b': 2 } },
+ { 'a': { 'b': 1 } }
];
-_.map(objects, _.property('a.b.c'));
+_.map(objects, _.property('a.b'));
// => [2, 1]
-_.map(_.sortBy(objects, _.property(['a', 'b', 'c'])), 'a.b.c');
+_.map(_.sortBy(objects, _.property(['a', 'b'])), 'a.b');
// => [1, 2]
```
* * *
<!-- div -->
### <a id="_propertyofobject"></a>`_.propertyOf(object)`
-<a href="#_propertyofobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13869 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.propertyof "See the npm package")
+<a href="#_propertyofobject">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15033 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.propertyof "See the npm package")
The opposite of `_.property`; this method creates a function that returns
the value at a given path of `object`.
+#### Since
+3.0.0
#### Arguments
1. `object` *(Object)*: The object to query.
#### Returns
-*(Function)*: Returns the new function.
+*(Function)*: Returns the new function.
#### Example
```js
<!-- div -->
### <a id="_rangestart0-end-step1"></a>`_.range([start=0], end, [step=1])`
-<a href="#_rangestart0-end-step1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13914 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.range "See the npm package")
+<a href="#_rangestart0-end-step1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15080 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.range "See the npm package")
-Creates an array of numbers (positive and/or negative) progressing from
+Creates an array of numbers *(positive and/or negative)* progressing from
`start` up to, but not including, `end`. A step of `-1` is used if a negative
-`start` is specified without an `end` or `step`. If `end` is not specified
+`start` is specified without an `end` or `step`. If `end` is not specified,
it's set to `start` with `start` then set to `0`.
<br>
<br>
**Note:** JavaScript follows the IEEE-754 standard for resolving
floating-point values which can produce unexpected results.
+#### Since
+0.1.0
#### Arguments
1. `[start=0]` *(number)*: The start of the range.
2. `end` *(number)*: The end of the range.
3. `[step=1]` *(number)*: The value to increment or decrement by.
#### Returns
-*(Array)*: Returns the new array of numbers.
+*(Array)*: Returns the new array of numbers.
#### Example
```js
<!-- div -->
### <a id="_rangerightstart0-end-step1"></a>`_.rangeRight([start=0], end, [step=1])`
-<a href="#_rangerightstart0-end-step1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13950 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.rangeright "See the npm package")
+<a href="#_rangerightstart0-end-step1">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15118 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.rangeright "See the npm package")
This method is like `_.range` except that it populates values in
descending order.
+#### Since
+4.0.0
#### Arguments
1. `[start=0]` *(number)*: The start of the range.
2. `end` *(number)*: The end of the range.
3. `[step=1]` *(number)*: The value to increment or decrement by.
#### Returns
-*(Array)*: Returns the new array of numbers.
+*(Array)*: Returns the new array of numbers.
#### Example
```js
<!-- div -->
### <a id="_runincontextcontextroot"></a>`_.runInContext([context=root])`
-<a href="#_runincontextcontextroot">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1296 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.runincontext "See the npm package")
+<a href="#_runincontextcontextroot">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1239 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.runincontext "See the npm package")
Create a new pristine `lodash` function using the `context` object.
+#### Since
+1.1.0
#### Arguments
1. `[context=root]` *(Object)*: The context object.
#### Returns
-*(Function)*: Returns a new `lodash` function.
+*(Function)*: Returns a new `lodash` function.
#### Example
```js
<!-- div -->
### <a id="_timesn-iteratee_identity"></a>`_.times(n, [iteratee=_.identity])`
-<a href="#_timesn-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L13970 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.times "See the npm package")
+<a href="#_timesn-iteratee_identity">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15139 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.times "See the npm package")
Invokes the iteratee `n` times, returning an array of the results of
-each invocation. The iteratee is invoked with one argument; (index).
+each invocation. The iteratee is invoked with one argument; *(index)*.
+#### Since
+0.1.0
#### Arguments
1. `n` *(number)*: The number of times to invoke `iteratee`.
2. `[iteratee=_.identity]` *(Function)*: The function invoked per iteration.
#### Returns
-*(Array)*: Returns the array of results.
+*(Array)*: Returns the array of results.
#### Example
```js
<!-- div -->
### <a id="_topathvalue"></a>`_.toPath(value)`
-<a href="#_topathvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14013 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.topath "See the npm package")
+<a href="#_topathvalue">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15183 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.topath "See the npm package")
Converts `value` to a property path array.
+#### Since
+4.0.0
#### Arguments
1. `value` *(*)*: The value to convert.
#### Returns
-*(Array)*: Returns the new property path array.
+*(Array)*: Returns the new property path array.
#### Example
```js
<!-- div -->
### <a id="_uniqueidprefix"></a>`_.uniqueId([prefix=''])`
-<a href="#_uniqueidprefix">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14033 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniqueid "See the npm package")
+<a href="#_uniqueidprefix">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15207 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.uniqueid "See the npm package")
-Generates a unique ID. If `prefix` is given the ID is appended to it.
+Generates a unique ID. If `prefix` is given, the ID is appended to it.
+#### Since
+0.1.0
#### Arguments
1. `[prefix='']` *(string)*: The value to prefix the ID with.
#### Returns
-*(string)*: Returns the unique ID.
+*(string)*: Returns the unique ID.
#### Example
```js
<!-- div -->
### <a id="_version"></a>`_.VERSION`
-<a href="#_version">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L14680 "View in source") [Ⓣ][1]
+<a href="#_version">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L15894 "View in source") [Ⓣ][1]
-({string}): The semantic version number.
+(string): The semantic version number.
* * *
<!-- div -->
### <a id="_templatesettings"></a>`_.templateSettings`
-<a href="#_templatesettings">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1545 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.templatesettings "See the npm package")
+<a href="#_templatesettings">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1502 "View in source") [Ⓣ][1] [Ⓝ](https://www.npmjs.com/package/lodash.templatesettings "See the npm package")
-({Object}): By default, the template delimiters used by lodash are like those in
-embedded Ruby (ERB). Change the following template settings to use
+(Object): By default, the template delimiters used by lodash are like those in
+embedded Ruby *(ERB)*. Change the following template settings to use
alternative delimiters.
* * *
<!-- div -->
### <a id="_templatesettingsescape"></a>`_.templateSettings.escape`
-<a href="#_templatesettingsescape">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1553 "View in source") [Ⓣ][1]
+<a href="#_templatesettingsescape">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1510 "View in source") [Ⓣ][1]
-({RegExp}): Used to detect `data` property values to be HTML-escaped.
+(RegExp): Used to detect `data` property values to be HTML-escaped.
* * *
<!-- div -->
### <a id="_templatesettingsevaluate"></a>`_.templateSettings.evaluate`
-<a href="#_templatesettingsevaluate">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1561 "View in source") [Ⓣ][1]
+<a href="#_templatesettingsevaluate">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1518 "View in source") [Ⓣ][1]
-({RegExp}): Used to detect code to be evaluated.
+(RegExp): Used to detect code to be evaluated.
* * *
<!-- div -->
### <a id="_templatesettingsimports"></a>`_.templateSettings.imports`
-<a href="#_templatesettingsimports">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1585 "View in source") [Ⓣ][1]
+<a href="#_templatesettingsimports">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1542 "View in source") [Ⓣ][1]
-({Object}): Used to import variables into the compiled template.
+(Object): Used to import variables into the compiled template.
* * *
<!-- div -->
-### <a id="_templatesettingsimports_"></a>`_.templateSettings.imports._`
-<a href="#_templatesettingsimports_">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1593 "View in source") [Ⓣ][1]
+### <a id="_templatesettingsinterpolate"></a>`_.templateSettings.interpolate`
+<a href="#_templatesettingsinterpolate">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1526 "View in source") [Ⓣ][1]
-({Function}): A reference to the `lodash` function.
+(RegExp): Used to detect `data` property values to inject.
* * *
<!-- div -->
-### <a id="_templatesettingsinterpolate"></a>`_.templateSettings.interpolate`
-<a href="#_templatesettingsinterpolate">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1569 "View in source") [Ⓣ][1]
+### <a id="_templatesettingsvariable"></a>`_.templateSettings.variable`
+<a href="#_templatesettingsvariable">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1534 "View in source") [Ⓣ][1]
-({RegExp}): Used to detect `data` property values to inject.
+(string): Used to reference the data object in the template text.
* * *
<!-- /div -->
+<!-- /div -->
+
<!-- div -->
-### <a id="_templatesettingsvariable"></a>`_.templateSettings.variable`
-<a href="#_templatesettingsvariable">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.5.1/lodash.js#L1577 "View in source") [Ⓣ][1]
+## `Methods`
+
+<!-- div -->
+
+### <a id="_templatesettingsimports_"></a>`_.templateSettings.imports._`
+<a href="#_templatesettingsimports_">#</a> [Ⓢ](https://github.com/lodash/lodash/blob/4.11.2/lodash.js#L1550 "View in source") [Ⓣ][1]
-({string}): Used to reference the data object in the template text.
+A reference to the `lodash` function.
* * *
git://repos.xcallymotion.com / motion.git / blobdiff