diff --git a/doc/README.md b/doc/README.md index f49f865a8..ca5d97448 100644 --- a/doc/README.md +++ b/doc/README.md @@ -7,32 +7,32 @@ ## `Arrays` * [`_.compact`](#_compactarray) -* [`_.difference`](#_differencearray--array1-array2-) -* [`_.drop`](#_restarray--callbackn1-thisarg) -* [`_.findIndex`](#_findindexarray--callbackidentity-thisarg) -* [`_.findLastIndex`](#_findlastindexarray--callbackidentity-thisarg) -* [`_.first`](#_firstarray--callbackn-thisarg) -* [`_.flatten`](#_flattenarray--isshallowfalse-callbackidentity-thisarg) -* [`_.head`](#_firstarray--callbackn-thisarg) +* [`_.difference`](#_differencearray--array) +* [`_.drop`](#_restarray--callback1--thisarg) +* [`_.findIndex`](#_findindexarray--callbackidentity--thisarg) +* [`_.findLastIndex`](#_findlastindexarray--callbackidentity--thisarg) +* [`_.first`](#_firstarray--callback--thisarg) +* [`_.flatten`](#_flattenarray--isshallowfalse--callbackidentity--thisarg) +* [`_.head`](#_firstarray--callback--thisarg) * [`_.indexOf`](#_indexofarray-value--fromindex0) -* [`_.initial`](#_initialarray--callbackn1-thisarg) -* [`_.intersection`](#_intersectionarray1-array2-) -* [`_.last`](#_lastarray--callbackn-thisarg) +* [`_.initial`](#_initialarray--callback1--thisarg) +* [`_.intersection`](#_intersectionarray) +* [`_.last`](#_lastarray--callback--thisarg) * [`_.lastIndexOf`](#_lastindexofarray-value--fromindexarraylength-1) * [`_.object`](#_zipobjectkeys--values) -* [`_.pull`](#_pullarray--value1-value2-) +* [`_.pull`](#_pullarray--value) * [`_.range`](#_rangestart0-end--step1) -* [`_.remove`](#_removearray--callbackidentity-thisarg) -* [`_.rest`](#_restarray--callbackn1-thisarg) -* [`_.sortedIndex`](#_sortedindexarray-value--callbackidentity-thisarg) -* [`_.tail`](#_restarray--callbackn1-thisarg) -* [`_.take`](#_firstarray--callbackn-thisarg) -* [`_.union`](#_unionarray1-array2-) -* [`_.uniq`](#_uniqarray--issortedfalse-callbackidentity-thisarg) -* [`_.unique`](#_uniqarray--issortedfalse-callbackidentity-thisarg) -* [`_.unzip`](#_ziparray1-array2-) -* [`_.without`](#_withoutarray--value1-value2-) -* [`_.zip`](#_ziparray1-array2-) +* [`_.remove`](#_removearray--callbackidentity--thisarg) +* [`_.rest`](#_restarray--callback1--thisarg) +* [`_.sortedIndex`](#_sortedindexarray-value--callbackidentity--thisarg) +* [`_.tail`](#_restarray--callback1--thisarg) +* [`_.take`](#_firstarray--callback--thisarg) +* [`_.union`](#_unionarray) +* [`_.uniq`](#_uniqarray--issortedfalse--callbackidentity--thisarg) +* [`_.unique`](#_uniqarray--issortedfalse--callbackidentity--thisarg) +* [`_.unzip`](#_ziparray) +* [`_.without`](#_withoutarray--value) +* [`_.zip`](#_ziparray) * [`_.zipObject`](#_zipobjectkeys--values) @@ -55,42 +55,42 @@ ## `Collections` -* [`_.all`](#_everycollection--callbackidentity-thisarg) -* [`_.any`](#_somecollection--callbackidentity-thisarg) -* [`_.at`](#_atcollection--index1-index2-) -* [`_.collect`](#_mapcollection--callbackidentity-thisarg) +* [`_.all`](#_everycollection--callbackidentity--thisarg) +* [`_.any`](#_somecollection--callbackidentity--thisarg) +* [`_.at`](#_atcollection--index) +* [`_.collect`](#_mapcollection--callbackidentity--thisarg) * [`_.contains`](#_containscollection-target--fromindex0) -* [`_.countBy`](#_countbycollection--callbackidentity-thisarg) -* [`_.detect`](#_findcollection--callbackidentity-thisarg) -* [`_.each`](#_foreachcollection--callbackidentity-thisarg) -* [`_.eachRight`](#_foreachrightcollection--callbackidentity-thisarg) -* [`_.every`](#_everycollection--callbackidentity-thisarg) -* [`_.filter`](#_filtercollection--callbackidentity-thisarg) -* [`_.find`](#_findcollection--callbackidentity-thisarg) -* [`_.findLast`](#_findlastcollection--callbackidentity-thisarg) -* [`_.findWhere`](#_findcollection--callbackidentity-thisarg) -* [`_.foldl`](#_reducecollection--callbackidentity-accumulator-thisarg) -* [`_.foldr`](#_reducerightcollection--callbackidentity-accumulator-thisarg) -* [`_.forEach`](#_foreachcollection--callbackidentity-thisarg) -* [`_.forEachRight`](#_foreachrightcollection--callbackidentity-thisarg) -* [`_.groupBy`](#_groupbycollection--callbackidentity-thisarg) +* [`_.countBy`](#_countbycollection--callbackidentity--thisarg) +* [`_.detect`](#_findcollection--callbackidentity--thisarg) +* [`_.each`](#_foreachcollection--callbackidentity--thisarg) +* [`_.eachRight`](#_foreachrightcollection--callbackidentity--thisarg) +* [`_.every`](#_everycollection--callbackidentity--thisarg) +* [`_.filter`](#_filtercollection--callbackidentity--thisarg) +* [`_.find`](#_findcollection--callbackidentity--thisarg) +* [`_.findLast`](#_findlastcollection--callbackidentity--thisarg) +* [`_.findWhere`](#_findcollection--callbackidentity--thisarg) +* [`_.foldl`](#_reducecollection--callbackidentity--accumulator--thisarg) +* [`_.foldr`](#_reducerightcollection--callbackidentity--accumulator--thisarg) +* [`_.forEach`](#_foreachcollection--callbackidentity--thisarg) +* [`_.forEachRight`](#_foreachrightcollection--callbackidentity--thisarg) +* [`_.groupBy`](#_groupbycollection--callbackidentity--thisarg) * [`_.include`](#_containscollection-target--fromindex0) -* [`_.indexBy`](#_indexbycollection--callbackidentity-thisarg) -* [`_.inject`](#_reducecollection--callbackidentity-accumulator-thisarg) -* [`_.invoke`](#_invokecollection-methodname--arg1-arg2-) -* [`_.map`](#_mapcollection--callbackidentity-thisarg) -* [`_.max`](#_maxcollection--callbackidentity-thisarg) -* [`_.min`](#_mincollection--callbackidentity-thisarg) +* [`_.indexBy`](#_indexbycollection--callbackidentity--thisarg) +* [`_.inject`](#_reducecollection--callbackidentity--accumulator--thisarg) +* [`_.invoke`](#_invokecollection-methodname--arg) +* [`_.map`](#_mapcollection--callbackidentity--thisarg) +* [`_.max`](#_maxcollection--callbackidentity--thisarg) +* [`_.min`](#_mincollection--callbackidentity--thisarg) * [`_.pluck`](#_pluckcollection-property) -* [`_.reduce`](#_reducecollection--callbackidentity-accumulator-thisarg) -* [`_.reduceRight`](#_reducerightcollection--callbackidentity-accumulator-thisarg) -* [`_.reject`](#_rejectcollection--callbackidentity-thisarg) +* [`_.reduce`](#_reducecollection--callbackidentity--accumulator--thisarg) +* [`_.reduceRight`](#_reducerightcollection--callbackidentity--accumulator--thisarg) +* [`_.reject`](#_rejectcollection--callbackidentity--thisarg) * [`_.sample`](#_samplecollection--n) -* [`_.select`](#_filtercollection--callbackidentity-thisarg) +* [`_.select`](#_filtercollection--callbackidentity--thisarg) * [`_.shuffle`](#_shufflecollection) * [`_.size`](#_sizecollection) -* [`_.some`](#_somecollection--callbackidentity-thisarg) -* [`_.sortBy`](#_sortbycollection--callbackidentity-thisarg) +* [`_.some`](#_somecollection--callbackidentity--thisarg) +* [`_.sortBy`](#_sortbycollection--callbackidentity--thisarg) * [`_.toArray`](#_toarraycollection) * [`_.where`](#_wherecollection-properties) @@ -101,19 +101,19 @@ ## `Functions` * [`_.after`](#_aftern-func) -* [`_.bind`](#_bindfunc--thisarg-arg1-arg2-) -* [`_.bindAll`](#_bindallobject--methodname1-methodname2-) -* [`_.bindKey`](#_bindkeyobject-key--arg1-arg2-) -* [`_.compose`](#_composefunc1-func2-) -* [`_.createCallback`](#_createcallbackfuncidentity-thisarg-argcount) +* [`_.bind`](#_bindfunc--thisarg--arg) +* [`_.bindAll`](#_bindallobject--methodname) +* [`_.bindKey`](#_bindkeyobject-key--arg) +* [`_.compose`](#_composefunc) +* [`_.createCallback`](#_createcallbackfuncidentity--thisarg--argcount) * [`_.curry`](#_curryfunc--arityfunclength) * [`_.debounce`](#_debouncefunc-wait-options) -* [`_.defer`](#_deferfunc--arg1-arg2-) -* [`_.delay`](#_delayfunc-wait--arg1-arg2-) +* [`_.defer`](#_deferfunc--arg) +* [`_.delay`](#_delayfunc-wait--arg) * [`_.memoize`](#_memoizefunc--resolver) * [`_.once`](#_oncefunc) -* [`_.partial`](#_partialfunc--arg1-arg2-) -* [`_.partialRight`](#_partialrightfunc--arg1-arg2-) +* [`_.partial`](#_partialfunc--arg) +* [`_.partialRight`](#_partialrightfunc--arg) * [`_.throttle`](#_throttlefunc-wait-options) * [`_.wrap`](#_wrapvalue-wrapper) @@ -123,17 +123,17 @@ ## `Objects` -* [`_.assign`](#_assignobject--source1-source2--callback-thisarg) -* [`_.clone`](#_clonevalue--deepfalse-callback-thisarg) -* [`_.cloneDeep`](#_clonedeepvalue--callback-thisarg) -* [`_.defaults`](#_defaultsobject--source1-source2-) -* [`_.extend`](#_assignobject--source1-source2--callback-thisarg) -* [`_.findKey`](#_findkeyobject--callbackidentity-thisarg) -* [`_.findLastKey`](#_findlastkeyobject--callbackidentity-thisarg) -* [`_.forIn`](#_forinobject--callbackidentity-thisarg) -* [`_.forInRight`](#_forinrightobject--callbackidentity-thisarg) -* [`_.forOwn`](#_forownobject--callbackidentity-thisarg) -* [`_.forOwnRight`](#_forownrightobject--callbackidentity-thisarg) +* [`_.assign`](#_assignobject--source--callback--thisarg) +* [`_.clone`](#_clonevalue--deepfalse--callback--thisarg) +* [`_.cloneDeep`](#_clonedeepvalue--callback--thisarg) +* [`_.defaults`](#_defaultsobject--source) +* [`_.extend`](#_assignobject--source--callback--thisarg) +* [`_.findKey`](#_findkeyobject--callbackidentity--thisarg) +* [`_.findLastKey`](#_findlastkeyobject--callbackidentity--thisarg) +* [`_.forIn`](#_forinobject--callbackidentity--thisarg) +* [`_.forInRight`](#_forinrightobject--callbackidentity--thisarg) +* [`_.forOwn`](#_forownobject--callbackidentity--thisarg) +* [`_.forOwnRight`](#_forownrightobject--callbackidentity--thisarg) * [`_.functions`](#_functionsobject) * [`_.has`](#_hasobject-property) * [`_.invert`](#_invertobject) @@ -143,7 +143,7 @@ * [`_.isDate`](#_isdatevalue) * [`_.isElement`](#_iselementvalue) * [`_.isEmpty`](#_isemptyvalue) -* [`_.isEqual`](#_isequala-b--callback-thisarg) +* [`_.isEqual`](#_isequala-b--callback--thisarg) * [`_.isFinite`](#_isfinitevalue) * [`_.isFunction`](#_isfunctionvalue) * [`_.isNaN`](#_isnanvalue) @@ -155,12 +155,12 @@ * [`_.isString`](#_isstringvalue) * [`_.isUndefined`](#_isundefinedvalue) * [`_.keys`](#_keysobject) -* [`_.merge`](#_mergeobject--source1-source2--callback-thisarg) +* [`_.merge`](#_mergeobject--source--callback--thisarg) * [`_.methods`](#_functionsobject) -* [`_.omit`](#_omitobject-callback-prop1-prop2--thisarg) +* [`_.omit`](#_omitobject--callback--thisarg) * [`_.pairs`](#_pairsobject) -* [`_.pick`](#_pickobject-callback-prop1-prop2--thisarg) -* [`_.transform`](#_transformcollection--callbackidentity-accumulator-thisarg) +* [`_.pick`](#_pickobject--callback--thisarg) +* [`_.transform`](#_transformcollection--callbackidentity--accumulator--thisarg) * [`_.values`](#_valuesobject) @@ -174,7 +174,7 @@ * [`_.mixin`](#_mixinobject-object) * [`_.noConflict`](#_noconflict) * [`_.parseInt`](#_parseintvalue--radix) -* [`_.random`](#_randommin0-max1) +* [`_.random`](#_randommin0--max1) * [`_.result`](#_resultobject-property) * [`_.runInContext`](#_runincontextcontextroot) * [`_.template`](#_templatetext-data-options) @@ -231,15 +231,15 @@ ### `_.compact(array)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4090 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4123 "View in source") [Ⓣ][1] Creates an array with all falsey values removed. The values `false`, `null`, `0`, `""`, `undefined`, and `NaN` are all falsey. #### Arguments -1. `array` *(Array)*: The array to compact. +1. `array` *(array)*: The array to compact. #### Returns -*(Array)*: Returns a new array of filtered values. +*(array)*: Returns a new array of filtered values. #### Example ```js @@ -254,17 +254,17 @@ _.compact([0, 1, false, 2, '', 3]); -### `_.difference(array [, array1, array2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4119 "View in source") [Ⓣ][1] +### `_.difference(array, [array])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4152 "View in source") [Ⓣ][1] Creates an array excluding all values of the provided arrays using strict equality for comparisons, i.e. `===`. #### Arguments -1. `array` *(Array)*: The array to process. -2. `[array1, array2, ...]` *(Array)*: The arrays of values to exclude. +1. `array` *(array)*: The array to process. +2. `[array]` *(...array)*: The arrays of values to exclude. #### Returns -*(Array)*: Returns a new array of filtered values. +*(array)*: Returns a new array of filtered values. #### Example ```js @@ -279,18 +279,18 @@ _.difference([1, 2, 3, 4, 5], [5, 2, 10]); -### `_.findIndex(array [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4169 "View in source") [Ⓣ][1] +### `_.findIndex(array, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4202 "View in source") [Ⓣ][1] This method is like `_.find` except that it returns the index of the first element that passes the callback check, instead of the element itself. #### Arguments -1. `array` *(Array)*: The array to search. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to search. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the index of the found element, else `-1`. +*(number)*: Returns the index of the found element, else `-1`. #### Example ```js @@ -307,18 +307,18 @@ _.findIndex(['apple', 'banana', 'beet'], function(food) { -### `_.findLastIndex(array [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4202 "View in source") [Ⓣ][1] +### `_.findLastIndex(array, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4235 "View in source") [Ⓣ][1] This method is like `_.findIndex` except that it iterates over elements of a `collection` from right to left. #### Arguments -1. `array` *(Array)*: The array to search. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to search. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the index of the found element, else `-1`. +*(number)*: Returns the index of the found element, else `-1`. #### Example ```js @@ -335,8 +335,8 @@ _.findLastIndex(['apple', 'banana', 'beet'], function(food) { -### `_.first(array [, callback|n, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4269 "View in source") [Ⓣ][1] +### `_.first(array, [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4302 "View in source") [Ⓣ][1] Gets the first element or first `n` elements of an array. If a callback is provided elements at the beginning of the array are returned as long as the callback returns truthy. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -348,12 +348,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *head, take* #### Arguments -1. `array` *(Array)*: The array to query. -2. `[callback|n]` *(Function|Object|Number|String)*: The function called per element or the number of elements to return. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to query. +2. `[callback]` *(function|object|number|string)*: The function called per element or the number of elements to return. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the first element(s) of `array`. +*(\*)*: Returns the first element(s) of `array`. #### Example ```js @@ -395,8 +395,8 @@ _.first(food, { 'type': 'fruit' }); -### `_.flatten(array [, isShallow=false, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4331 "View in source") [Ⓣ][1] +### `_.flatten(array, [isShallow=false], [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4364 "View in source") [Ⓣ][1] Flattens a nested array *(the nesting can be to any depth)*. If `isShallow` is truthy, the array will only be flattened a single level. If a callback is provided each element of the array is passed through the callback before flattening. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -405,13 +405,13 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `array` *(Array)*: The array to flatten. -2. `[isShallow=false]` *(Boolean)*: A flag to restrict flattening to a single level. -3. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to flatten. +2. `[isShallow=false]` *(boolean)*: A flag to restrict flattening to a single level. +3. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a new flattened array. +*(array)*: Returns a new flattened array. #### Example ```js @@ -438,18 +438,18 @@ _.flatten(stooges, 'quotes'); -### `_.indexOf(array, value [, fromIndex=0])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4368 "View in source") [Ⓣ][1] +### `_.indexOf(array, value, [fromIndex=0])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4401 "View in source") [Ⓣ][1] Gets the index at which the first occurrence of `value` is found using strict equality for comparisons, i.e. `===`. If the array is already sorted providing `true` for `fromIndex` will run a faster binary search. #### Arguments -1. `array` *(Array)*: The array to search. -2. `value` *(Mixed)*: The value to search for. -3. `[fromIndex=0]` *(Boolean|Number)*: The index to search from or `true` to perform a binary search on a sorted array. +1. `array` *(array)*: The array to search. +2. `value` *(\*)*: The value to search for. +3. `[fromIndex=0]` *(boolean|number)*: The index to search from or `true` to perform a binary search on a sorted array. #### Returns -*(Number)*: Returns the index of the matched value or `-1`. +*(number)*: Returns the index of the matched value or `-1`. #### Example ```js @@ -470,8 +470,8 @@ _.indexOf([1, 1, 2, 2, 3, 3], 2, true); -### `_.initial(array [, callback|n=1, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4434 "View in source") [Ⓣ][1] +### `_.initial(array, [callback=1], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4467 "View in source") [Ⓣ][1] Gets all but the last element or last `n` elements of an array. If a callback is provided elements at the end of the array are excluded from the result as long as the callback returns truthy. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -480,12 +480,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `array` *(Array)*: The array to query. -2. `[callback|n=1]` *(Function|Object|Number|String)*: The function called per element or the number of elements to exclude. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to query. +2. `[callback=1]` *(function|object|number|string)*: The function called per element or the number of elements to exclude. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a slice of `array`. +*(array)*: Returns a slice of `array`. #### Example ```js @@ -527,16 +527,16 @@ _.initial(food, { 'type': 'vegetable' }); -### `_.intersection([array1, array2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4467 "View in source") [Ⓣ][1] +### `_.intersection([array])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4500 "View in source") [Ⓣ][1] Creates an array of unique values present in all provided arrays using strict equality for comparisons, i.e. `===`. #### Arguments -1. `[array1, array2, ...]` *(Array)*: The arrays to inspect. +1. `[array]` *(...array)*: The arrays to inspect. #### Returns -*(Array)*: Returns an array of composite values. +*(array)*: Returns an array of composite values. #### Example ```js @@ -551,8 +551,8 @@ _.intersection([1, 2, 3], [101, 2, 1, 10], [2, 1]); -### `_.last(array [, callback|n, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4567 "View in source") [Ⓣ][1] +### `_.last(array, [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4600 "View in source") [Ⓣ][1] Gets the last element or last `n` elements of an array. If a callback is provided elements at the end of the array are returned as long as the callback returns truthy. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -561,12 +561,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `array` *(Array)*: The array to query. -2. `[callback|n]` *(Function|Object|Number|String)*: The function called per element or the number of elements to return. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to query. +2. `[callback]` *(function|object|number|string)*: The function called per element or the number of elements to return. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the last element(s) of `array`. +*(\*)*: Returns the last element(s) of `array`. #### Example ```js @@ -608,18 +608,18 @@ _.last(food, { 'type': 'vegetable' }); -### `_.lastIndexOf(array, value [, fromIndex=array.length-1])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4608 "View in source") [Ⓣ][1] +### `_.lastIndexOf(array, value, [fromIndex=array.length-1])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4641 "View in source") [Ⓣ][1] Gets the index at which the last occurrence of `value` is found using strict equality for comparisons, i.e. `===`. If `fromIndex` is negative, it is used as the offset from the end of the collection. #### Arguments -1. `array` *(Array)*: The array to search. -2. `value` *(Mixed)*: The value to search for. -3. `[fromIndex=array.length-1]` *(Number)*: The index to search from. +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 or `-1`. +*(number)*: Returns the index of the matched value or `-1`. #### Example ```js @@ -637,17 +637,17 @@ _.lastIndexOf([1, 2, 3, 1, 2, 3], 2, 3); -### `_.pull(array [, value1, value2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4638 "View in source") [Ⓣ][1] +### `_.pull(array, [value])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4671 "View in source") [Ⓣ][1] Removes all provided values from the given array using strict equality for comparisons, i.e. `===`. #### Arguments -1. `array` *(Array)*: The array to modify. -2. `[value1, value2, ...]` *(Mixed)*: The values to remove. +1. `array` *(array)*: The array to modify. +2. `[value]` *(...\*)*: The values to remove. #### Returns -*(Array)*: Returns `array`. +*(array)*: Returns `array`. #### Example ```js @@ -664,18 +664,18 @@ console.log(array); -### `_.range([start=0], end [, step=1])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4689 "View in source") [Ⓣ][1] +### `_.range([start=0], end, [step=1])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4722 "View in source") [Ⓣ][1] Creates an array of numbers *(positive and/or negative)* progressing from `start` up to but not including `end`. If `start` is less than `stop` a zero-length range is created unless a negative `step` is specified. #### 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. +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 a new range array. +*(array)*: Returns a new range array. #### Example ```js @@ -705,8 +705,8 @@ _.range(0); -### `_.remove(array [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4742 "View in source") [Ⓣ][1] +### `_.remove(array, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4775 "View in source") [Ⓣ][1] Removes all elements from an array that the callback returns truthy for and returns an array of removed elements. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -715,12 +715,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `array` *(Array)*: The array to modify. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to modify. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a new array of removed elements. +*(array)*: Returns a new array of removed elements. #### Example ```js @@ -741,8 +741,8 @@ console.log(evens); -### `_.rest(array [, callback|n=1, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4816 "View in source") [Ⓣ][1] +### `_.rest(array, [callback=1], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4849 "View in source") [Ⓣ][1] The opposite of `_.initial` this method gets all but the first element or first `n` elements of an array. If a callback function is provided elements at the beginning of the array are excluded from the result as long as the callback returns truthy. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -754,12 +754,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *drop, tail* #### Arguments -1. `array` *(Array)*: The array to query. -2. `[callback|n=1]` *(Function|Object|Number|String)*: The function called per element or the number of elements to exclude. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to query. +2. `[callback=1]` *(function|object|number|string)*: The function called per element or the number of elements to exclude. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a slice of `array`. +*(array)*: Returns a slice of `array`. #### Example ```js @@ -801,8 +801,8 @@ _.rest(food, { 'type': 'fruit' }); -### `_.sortedIndex(array, value [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4880 "View in source") [Ⓣ][1] +### `_.sortedIndex(array, value, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4913 "View in source") [Ⓣ][1] Uses a binary search to determine the smallest index at which a value should be inserted into a given sorted array in order to maintain the sort order of the array. If a callback is provided it will be executed for `value` and each element of `array` to compute their sort ranking. The callback is bound to `thisArg` and invoked with one argument; *(value)*. @@ -811,13 +811,13 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `array` *(Array)*: The array to inspect. -2. `value` *(Mixed)*: The value to evaluate. -3. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to inspect. +2. `value` *(\*)*: The value to evaluate. +3. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### 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 @@ -850,16 +850,16 @@ _.sortedIndex(['twenty', 'thirty', 'fifty'], 'fourty', function(word) { -### `_.union([array1, array2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4911 "View in source") [Ⓣ][1] +### `_.union([array])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4944 "View in source") [Ⓣ][1] Creates an array of unique values, in order, of the provided arrays using strict equality for comparisons, i.e. `===`. #### Arguments -1. `[array1, array2, ...]` *(Array)*: The arrays to inspect. +1. `[array]` *(...array)*: The arrays to inspect. #### Returns -*(Array)*: Returns an array of composite values. +*(array)*: Returns an array of composite values. #### Example ```js @@ -874,8 +874,8 @@ _.union([1, 2, 3], [101, 2, 1, 10], [2, 1]); -### `_.uniq(array [, isSorted=false, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4959 "View in source") [Ⓣ][1] +### `_.uniq(array, [isSorted=false], [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4992 "View in source") [Ⓣ][1] Creates a duplicate-value-free version of an array using strict equality for comparisons, i.e. `===`. If the array is sorted, providing `true` for `isSorted` will use a faster algorithm. If a callback is provided each element of `array` is passed through the callback before uniqueness is computed. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, array)*. @@ -887,13 +887,13 @@ If an object is provided for `callback` the created "_.where" style callback wil *unique* #### Arguments -1. `array` *(Array)*: The array to process. -2. `[isSorted=false]` *(Boolean)*: A flag to indicate that `array` is sorted. -3. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `array` *(array)*: The array to process. +2. `[isSorted=false]` *(boolean)*: A flag to indicate that `array` is sorted. +3. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a duplicate-value-free array. +*(array)*: Returns a duplicate-value-free array. #### Example ```js @@ -921,17 +921,17 @@ _.uniq([{ 'x': 1 }, { 'x': 2 }, { 'x': 1 }], 'x'); -### `_.without(array [, value1, value2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4987 "View in source") [Ⓣ][1] +### `_.without(array, [value])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5020 "View in source") [Ⓣ][1] Creates an array excluding all provided values using strict equality for comparisons, i.e. `===`. #### Arguments -1. `array` *(Array)*: The array to filter. -2. `[value1, value2, ...]` *(Mixed)*: The values to exclude. +1. `array` *(array)*: The array to filter. +2. `[value]` *(...\*)*: The values to exclude. #### Returns -*(Array)*: Returns a new array of filtered values. +*(array)*: Returns a new array of filtered values. #### Example ```js @@ -946,8 +946,8 @@ _.without([1, 2, 1, 0, 3, 1, 4], 0, 1); -### `_.zip([array1, array2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5007 "View in source") [Ⓣ][1] +### `_.zip([array])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5040 "View in source") [Ⓣ][1] 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. @@ -955,10 +955,10 @@ Creates an array of grouped elements, the first of which contains the first elem *unzip* #### Arguments -1. `[array1, array2, ...]` *(Array)*: Arrays to process. +1. `[array]` *(...array)*: Arrays to process. #### Returns -*(Array)*: Returns a new array of grouped elements. +*(array)*: Returns a new array of grouped elements. #### Example ```js @@ -973,8 +973,8 @@ _.zip(['moe', 'larry'], [30, 40], [true, false]); -### `_.zipObject(keys [, values=[]])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5037 "View in source") [Ⓣ][1] +### `_.zipObject(keys, [values=[]])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5070 "View in source") [Ⓣ][1] Creates an object composed from arrays of `keys` and `values`. Provide either a single two dimensional array, i.e. `[[key1, value1], [key2, value2]]` or two arrays, one of `keys` and one of corresponding `values`. @@ -982,11 +982,11 @@ Creates an object composed from arrays of `keys` and `values`. Provide either a *object* #### Arguments -1. `keys` *(Array)*: The array of keys. -2. `[values=[]]` *(Array)*: The array of values. +1. `keys` *(array)*: The array of keys. +2. `[values=[]]` *(array)*: The array of values. #### Returns -*(Object)*: Returns an object composed of the given keys and corresponding values. +*(object)*: Returns an object composed of the given keys and corresponding values. #### Example ```js @@ -1009,7 +1009,7 @@ _.zipObject(['moe', 'larry'], [30, 40]); ### `_(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L620 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L628 "View in source") [Ⓣ][1] Creates a `lodash` object which wraps the given value to enable method chaining. @@ -1027,10 +1027,10 @@ The non-chainable wrapper functions are:
The wrapper functions `first` and `last` return wrapped values when `n` is provided, otherwise they return unwrapped values. #### Arguments -1. `value` *(Mixed)*: The value to wrap in a `lodash` instance. +1. `value` *(\*)*: The value to wrap in a `lodash` instance. #### Returns -*(Object)*: Returns a `lodash` instance. +*(object)*: Returns a `lodash` instance. #### Example ```js @@ -1062,15 +1062,15 @@ _.isArray(squares.value()); ### `_.chain(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6224 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6262 "View in source") [Ⓣ][1] Creates a `lodash` object that wraps the given `value`. #### Arguments -1. `value` *(Mixed)*: The value to wrap. +1. `value` *(\*)*: The value to wrap. #### Returns -*(Object)*: Returns the wrapper object. +*(object)*: Returns the wrapper object. #### Example ```js @@ -1095,16 +1095,16 @@ var youngest = _.chain(stooges) ### `_.tap(value, interceptor)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6252 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6290 "View in source") [Ⓣ][1] Invokes `interceptor` with the `value` as the first argument and then returns `value`. The purpose of this method is to "tap into" a method chain in order to perform operations on intermediate results within the chain. #### Arguments -1. `value` *(Mixed)*: The value to provide to `interceptor`. -2. `interceptor` *(Function)*: The function to invoke. +1. `value` *(\*)*: The value to provide to `interceptor`. +2. `interceptor` *(function)*: The function to invoke. #### Returns -*(Mixed)*: Returns `value`. +*(\*)*: Returns `value`. #### Example ```js @@ -1125,12 +1125,12 @@ _([1, 2, 3, 4]) ### `_.prototype.chain()` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6272 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6310 "View in source") [Ⓣ][1] Enables method chaining on the wrapper object. #### Returns -*(Mixed)*: Returns the wrapper object. +*(\*)*: Returns the wrapper object. #### Example ```js @@ -1149,12 +1149,12 @@ var sum = _([1, 2, 3]) ### `_.prototype.toString()` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6289 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6327 "View in source") [Ⓣ][1] Produces the `toString` result of the wrapped value. #### Returns -*(String)*: Returns the string result. +*(string)*: Returns the string result. #### Example ```js @@ -1170,7 +1170,7 @@ _([1, 2, 3]).toString(); ### `_.prototype.valueOf()` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6306 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6344 "View in source") [Ⓣ][1] Extracts the wrapped value. @@ -1178,7 +1178,7 @@ Extracts the wrapped value. *value* #### Returns -*(Mixed)*: Returns the wrapped value. +*(\*)*: Returns the wrapped value. #### Example ```js @@ -1200,17 +1200,17 @@ _([1, 2, 3]).valueOf(); -### `_.at(collection [, index1, index2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2956 "View in source") [Ⓣ][1] +### `_.at(collection, [index])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2981 "View in source") [Ⓣ][1] Creates an array of elements from the specified indexes, or keys, of the `collection`. Indexes may be specified as individual arguments or as arrays of indexes. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[index1, index2, ...]` *(Array|Number|String)*: The indexes of `collection` to retrieve, specified as individual indexes or arrays of indexes. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[index]` *(...(number|number[]|string|string[])*: The indexes of `collection` to retrieve, specified as individual indexes or arrays of indexes. #### Returns -*(Array)*: Returns a new array of elements corresponding to the provided indexes. +*(array)*: Returns a new array of elements corresponding to the provided indexes. #### Example ```js @@ -1228,8 +1228,8 @@ _.at(['moe', 'larry', 'curly'], 0, 2); -### `_.contains(collection, target [, fromIndex=0])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2999 "View in source") [Ⓣ][1] +### `_.contains(collection, target, [fromIndex=0])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3024 "View in source") [Ⓣ][1] Checks if a given value is present in a collection using strict equality for comparisons, i.e. `===`. If `fromIndex` is negative, it is used as the offset from the end of the collection. @@ -1237,12 +1237,12 @@ Checks if a given value is present in a collection using strict equality for com *include* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `target` *(Mixed)*: The value to check for. -3. `[fromIndex=0]` *(Number)*: The index to search from. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `target` *(\*)*: The value to check for. +3. `[fromIndex=0]` *(number)*: The index to search from. #### Returns -*(Boolean)*: Returns `true` if the `target` element is found, else `false`. +*(boolean)*: Returns `true` if the `target` element is found, else `false`. #### Example ```js @@ -1266,8 +1266,8 @@ _.contains('curly', 'ur'); -### `_.countBy(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3055 "View in source") [Ⓣ][1] +### `_.countBy(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3080 "View in source") [Ⓣ][1] Creates an object composed of keys generated from the results of running each element of `collection` through the callback. The corresponding value of each key is the number of times the key was returned by the callback. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1276,12 +1276,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns the composed aggregate object. +*(object)*: Returns the composed aggregate object. #### Example ```js @@ -1302,8 +1302,8 @@ _.countBy(['one', 'two', 'three'], 'length'); -### `_.every(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3100 "View in source") [Ⓣ][1] +### `_.every(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3125 "View in source") [Ⓣ][1] Checks if the given callback returns truthy value for **all** elements of a collection. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1315,12 +1315,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *all* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Boolean)*: Returns `true` if all elements passed the callback check, else `false`. +*(boolean)*: Returns `true` if all elements passed the callback check, else `false`. #### Example ```js @@ -1348,8 +1348,8 @@ _.every(stooges, { 'age': 50 }); -### `_.filter(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3161 "View in source") [Ⓣ][1] +### `_.filter(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3186 "View in source") [Ⓣ][1] Iterates over elements of a collection, returning an array of all elements the callback returns truthy for. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1361,12 +1361,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *select* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a new array of elements that passed the callback check. +*(array)*: Returns a new array of elements that passed the callback check. #### Example ```js @@ -1394,8 +1394,8 @@ _.filter(food, { 'type': 'fruit' }); -### `_.find(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3228 "View in source") [Ⓣ][1] +### `_.find(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3253 "View in source") [Ⓣ][1] Iterates over elements of a collection, returning the first element that the callback returns truthy for. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1407,12 +1407,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *detect, findWhere* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the found element, else `undefined`. +*(\*)*: Returns the found element, else `undefined`. #### Example ```js @@ -1443,18 +1443,18 @@ _.find(food, 'organic'); -### `_.findLast(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3273 "View in source") [Ⓣ][1] +### `_.findLast(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3298 "View in source") [Ⓣ][1] This method is like `_.find` except that it iterates over elements of a `collection` from right to left. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the found element, else `undefined`. +*(\*)*: Returns the found element, else `undefined`. #### Example ```js @@ -1471,8 +1471,8 @@ _.findLast([1, 2, 3, 4], function(num) { -### `_.forEach(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3307 "View in source") [Ⓣ][1] +### `_.forEach(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3332 "View in source") [Ⓣ][1] Iterates over elements of a collection, executing the callback for each element. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. Callbacks may exit iteration early by explicitly returning `false`. @@ -1480,12 +1480,12 @@ Iterates over elements of a collection, executing the callback for each element. *each* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array, Object, String)*: Returns `collection`. +*((array, object, string)*): Returns `collection`. #### Example ```js @@ -1503,8 +1503,8 @@ _.forEach({ 'one': 1, 'two': 2, 'three': 3 }, function(num) { console.log(num); -### `_.forEachRight(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3340 "View in source") [Ⓣ][1] +### `_.forEachRight(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3365 "View in source") [Ⓣ][1] This method is like `_.forEach` except that it iterates over elements of a `collection` from right to left. @@ -1512,12 +1512,12 @@ This method is like `_.forEach` except that it iterates over elements of a `coll *eachRight* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array, Object, String)*: Returns `collection`. +*((array, object, string)*): Returns `collection`. #### Example ```js @@ -1532,8 +1532,8 @@ _([1, 2, 3]).forEachRight(function(num) { console.log(num); }).join(','); -### `_.groupBy(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3393 "View in source") [Ⓣ][1] +### `_.groupBy(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3426 "View in source") [Ⓣ][1] Creates an object composed of keys generated from the results of running each element of a collection through the callback. The corresponding value of each key is an array of the elements responsible for generating the key. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1542,12 +1542,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false` #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns the composed aggregate object. +*(object)*: Returns the composed aggregate object. #### Example ```js @@ -1569,8 +1569,8 @@ _.groupBy(['one', 'two', 'three'], 'length'); -### `_.indexBy(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3436 "View in source") [Ⓣ][1] +### `_.indexBy(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3469 "View in source") [Ⓣ][1] Creates an object composed of keys generated from the results of running each element of the collection through the given callback. The corresponding value of each key is the last element responsible for generating the key. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1579,12 +1579,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns the composed aggregate object. +*(object)*: Returns the composed aggregate object. #### Example ```js @@ -1610,18 +1610,18 @@ _.indexBy(stooges, function(key) { this.fromCharCode(key.code); }, String); -### `_.invoke(collection, methodName [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3462 "View in source") [Ⓣ][1] +### `_.invoke(collection, methodName, [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3495 "View in source") [Ⓣ][1] Invokes the method named by `methodName` on each element in the `collection` returning an array of the results of each invoked method. Additional arguments will be provided to each invoked method. If `methodName` is a function it will be invoked for, and `this` bound to, each element in the `collection`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `methodName` *(Function|String)*: The name of the method to invoke or the function invoked per iteration. -3. `[arg1, arg2, ...]` *(Mixed)*: Arguments to invoke the method with. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `methodName` *(function|string)*: The name of the method to invoke or the function invoked per iteration. +3. `[arg]` *(...\*)*: Arguments to invoke the method with. #### Returns -*(Array)*: Returns a new array of the results of each invoked method. +*(array)*: Returns a new array of the results of each invoked method. #### Example ```js @@ -1639,8 +1639,8 @@ _.invoke([123, 456], String.prototype.split, ''); -### `_.map(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3514 "View in source") [Ⓣ][1] +### `_.map(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3547 "View in source") [Ⓣ][1] Creates an array of values by running each element in the collection through the callback. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -1652,12 +1652,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *collect* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a new array of the results of each `callback` execution. +*(array)*: Returns a new array of the results of each `callback` execution. #### Example ```js @@ -1684,8 +1684,8 @@ _.map(stooges, 'name'); -### `_.max(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3571 "View in source") [Ⓣ][1] +### `_.max(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3604 "View in source") [Ⓣ][1] Retrieves the maximum value of an array. If a callback is provided it will be executed for each value in the array to generate the criterion by which the value is ranked. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, collection)*. @@ -1694,12 +1694,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the maximum value. +*(\*)*: Returns the maximum value. #### Example ```js @@ -1726,8 +1726,8 @@ _.max(stooges, 'age'); -### `_.min(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3640 "View in source") [Ⓣ][1] +### `_.min(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3673 "View in source") [Ⓣ][1] Retrieves the minimum value of an array. If a callback is provided it will be executed for each value in the array to generate the criterion by which the value is ranked. The callback is bound to `thisArg` and invoked with three arguments; *(value, index, collection)*. @@ -1736,12 +1736,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the minimum value. +*(\*)*: Returns the minimum value. #### Example ```js @@ -1769,16 +1769,16 @@ _.min(stooges, 'age'); ### `_.pluck(collection, property)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3690 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3723 "View in source") [Ⓣ][1] Retrieves the value of a specified property from all elements in the `collection`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `property` *(String)*: The property to pluck. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `property` *(string)*: The property to pluck. #### Returns -*(Array)*: Returns a new array of property values. +*(array)*: Returns a new array of property values. #### Example ```js @@ -1798,8 +1798,8 @@ _.pluck(stooges, 'name'); -### `_.reduce(collection [, callback=identity, accumulator, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3722 "View in source") [Ⓣ][1] +### `_.reduce(collection, [callback=identity], [accumulator], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3755 "View in source") [Ⓣ][1] Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If `accumulator` is not provided the first element of the collection will be used as the initial `accumulator` value. The callback is bound to `thisArg` and invoked with four arguments; *(accumulator, value, index|key, collection)*. @@ -1807,13 +1807,13 @@ Reduces a collection to a value which is the accumulated result of running each *foldl, inject* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[accumulator]` *(Mixed)*: Initial value of the accumulator. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[accumulator]` *(\*)*: Initial value of the accumulator. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the accumulated value. +*(\*)*: Returns the accumulated value. #### Example ```js @@ -1836,8 +1836,8 @@ var mapped = _.reduce({ 'a': 1, 'b': 2, 'c': 3 }, function(result, num, key) { -### `_.reduceRight(collection [, callback=identity, accumulator, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3765 "View in source") [Ⓣ][1] +### `_.reduceRight(collection, [callback=identity], [accumulator], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3798 "View in source") [Ⓣ][1] This method is like `_.reduce` except that it iterates over elements of a `collection` from right to left. @@ -1845,13 +1845,13 @@ This method is like `_.reduce` except that it iterates over elements of a `colle *foldr* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[accumulator]` *(Mixed)*: Initial value of the accumulator. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[accumulator]` *(\*)*: Initial value of the accumulator. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the accumulated value. +*(\*)*: Returns the accumulated value. #### Example ```js @@ -1867,8 +1867,8 @@ var flat = _.reduceRight(list, function(a, b) { return a.concat(b); }, []); -### `_.reject(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3814 "View in source") [Ⓣ][1] +### `_.reject(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3847 "View in source") [Ⓣ][1] The opposite of `_.filter` this method returns the elements of a collection that the callback does **not** return truthy for. @@ -1877,12 +1877,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a new array of elements that failed the callback check. +*(array)*: Returns a new array of elements that failed the callback check. #### Example ```js @@ -1910,17 +1910,17 @@ _.reject(food, { 'type': 'fruit' }); -### `_.sample(collection [, n])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3840 "View in source") [Ⓣ][1] +### `_.sample(collection, [n])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3873 "View in source") [Ⓣ][1] Retrieves a random element or `n` random elements from a collection. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to sample. -2. `[n]` *(Number)*: The number of elements to sample. +1. `collection` *(array|object|string)*: The collection to sample. +2. `[n]` *(number)*: The number of elements to sample. #### Returns -*(Array)*: Returns the random sample(s) of `collection`. +*(array)*: Returns the random sample(s) of `collection`. #### Example ```js @@ -1939,15 +1939,15 @@ _.sample([1, 2, 3, 4], 2); ### `_.shuffle(collection)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3866 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3899 "View in source") [Ⓣ][1] Creates an array of shuffled values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to shuffle. +1. `collection` *(array|object|string)*: The collection to shuffle. #### Returns -*(Array)*: Returns a new shuffled collection. +*(array)*: Returns a new shuffled collection. #### Example ```js @@ -1963,15 +1963,15 @@ _.shuffle([1, 2, 3, 4, 5, 6]); ### `_.size(collection)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3899 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3932 "View in source") [Ⓣ][1] Gets the size of the `collection` by returning `collection.length` for arrays and array-like objects or the number of own enumerable properties for objects. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to inspect. +1. `collection` *(array|object|string)*: The collection to inspect. #### Returns -*(Number)*: Returns `collection.length` or number of own enumerable properties. +*(number)*: Returns `collection.length` or number of own enumerable properties. #### Example ```js @@ -1992,8 +1992,8 @@ _.size('curly'); -### `_.some(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3946 "View in source") [Ⓣ][1] +### `_.some(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L3979 "View in source") [Ⓣ][1] Checks if the callback returns a truthy value for **any** element of a collection. The function returns as soon as it finds a passing value and does not iterate over the entire collection. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -2005,12 +2005,12 @@ If an object is provided for `callback` the created "_.where" style callback wil *any* #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Boolean)*: Returns `true` if any element passed the callback check, else `false`. +*(boolean)*: Returns `true` if any element passed the callback check, else `false`. #### Example ```js @@ -2038,8 +2038,8 @@ _.some(food, { 'type': 'meat' }); -### `_.sortBy(collection [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4002 "View in source") [Ⓣ][1] +### `_.sortBy(collection, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4035 "View in source") [Ⓣ][1] Creates an array of elements, sorted in ascending order by the results of running each element in a collection through the callback. This method performs a stable sort, that is, it will preserve the original sort order of equal elements. The callback is bound to `thisArg` and invoked with three arguments; *(value, index|key, collection)*. @@ -2048,12 +2048,12 @@ If a property name is provided for `callback` the created "_.pluck" style callba If an object is provided for `callback` the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns a new array of sorted elements. +*(array)*: Returns a new array of sorted elements. #### Example ```js @@ -2076,15 +2076,15 @@ _.sortBy(['banana', 'strawberry', 'apple'], 'length'); ### `_.toArray(collection)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4038 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4071 "View in source") [Ⓣ][1] Converts the `collection` to an array. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to convert. +1. `collection` *(array|object|string)*: The collection to convert. #### Returns -*(Array)*: Returns the new converted array. +*(array)*: Returns the new converted array. #### Example ```js @@ -2100,16 +2100,16 @@ Converts the `collection` to an array. ### `_.where(collection, properties)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4072 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L4105 "View in source") [Ⓣ][1] Performs a deep comparison of each element in a `collection` to the given `properties` object, returning an array of all elements that have equivalent property values. #### Arguments -1. `collection` *(Array|Object|String)*: The collection to iterate over. -2. `properties` *(Object)*: The object of property values to filter by. +1. `collection` *(array|object|string)*: The collection to iterate over. +2. `properties` *(object)*: The object of property values to filter by. #### Returns -*(Array)*: Returns a new array of elements that have the given `properties`. +*(array)*: Returns a new array of elements that have the given `properties`. #### Example ```js @@ -2140,16 +2140,16 @@ _.where(stooges, { 'quotes': ['Poifect!'] }); ### `_.after(n, func)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5074 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5107 "View in source") [Ⓣ][1] Creates a function this is restricted to executing `func` with the `this` binding and arguments of the created function, only after it is called `n` times. #### Arguments -1. `n` *(Number)*: The number of times the function must be called before `func` is executed. -2. `func` *(Function)*: The function to restrict. +1. `n` *(number)*: The number of times the function must be called before `func` is executed. +2. `func` *(function)*: The function to restrict. #### Returns -*(Function)*: Returns the new restricted function. +*(function)*: Returns the new restricted function. #### Example ```js @@ -2167,18 +2167,18 @@ _.forEach(notes, function(note) { -### `_.bind(func [, thisArg, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5107 "View in source") [Ⓣ][1] +### `_.bind(func, [thisArg], [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5140 "View in source") [Ⓣ][1] Creates a function that, when called, invokes `func` with the `this` binding of `thisArg` and prepends any additional `bind` arguments to those provided to the bound function. #### Arguments -1. `func` *(Function)*: The function to bind. -2. `[thisArg]` *(Mixed)*: The `this` binding of `func`. -3. `[arg1, arg2, ...]` *(Mixed)*: Arguments to be partially applied. +1. `func` *(function)*: The function to bind. +2. `[thisArg]` *(\*)*: The `this` binding of `func`. +3. `[arg]` *(...\*)*: Arguments to be partially applied. #### Returns -*(Function)*: Returns the new bound function. +*(function)*: Returns the new bound function. #### Example ```js @@ -2198,17 +2198,17 @@ func(); -### `_.bindAll(object [, methodName1, methodName2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5135 "View in source") [Ⓣ][1] +### `_.bindAll(object, [methodName])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5168 "View in source") [Ⓣ][1] Binds methods of an object to the object itself, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided all the function properties of `object` will be bound. #### Arguments -1. `object` *(Object)*: The object to bind and assign the bound methods to. -2. `[methodName1, methodName2, ...]` *(String)*: The object method names to bind, specified as individual method names or arrays of method names. +1. `object` *(object)*: The object to bind and assign the bound methods to. +2. `[methodName]` *(...string)*: The object method names to bind, specified as individual method names or arrays of method names. #### Returns -*(Object)*: Returns `object`. +*(object)*: Returns `object`. #### Example ```js @@ -2229,18 +2229,18 @@ jQuery('#docs').on('click', view.onClick); -### `_.bindKey(object, key [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5181 "View in source") [Ⓣ][1] +### `_.bindKey(object, key, [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5214 "View in source") [Ⓣ][1] Creates a function that, when called, invokes the method at `object[key]` and prepends any additional `bindKey` arguments to those provided to the bound function. This method differs from `_.bind` by allowing bound functions to reference methods that will be redefined or don't yet exist. See http://michaux.ca/articles/lazy-function-definition-pattern. #### Arguments -1. `object` *(Object)*: The object the method belongs to. -2. `key` *(String)*: The key of the method. -3. `[arg1, arg2, ...]` *(Mixed)*: Arguments to be partially applied. +1. `object` *(object)*: The object the method belongs to. +2. `key` *(string)*: The key of the method. +3. `[arg]` *(...\*)*: Arguments to be partially applied. #### Returns -*(Function)*: Returns the new bound function. +*(function)*: Returns the new bound function. #### Example ```js @@ -2270,16 +2270,16 @@ func(); -### `_.compose([func1, func2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5215 "View in source") [Ⓣ][1] +### `_.compose([func])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5248 "View in source") [Ⓣ][1] Creates a function that is the composition of the provided functions, where each function consumes the return value of the function that follows. For example, composing the functions `f()`, `g()`, and `h()` produces `f(g(h()))`. Each function is executed with the `this` binding of the composed function. #### Arguments -1. `[func1, func2, ...]` *(Function)*: Functions to compose. +1. `[func]` *(...function)*: Functions to compose. #### Returns -*(Function)*: Returns the new composed function. +*(function)*: Returns the new composed function. #### Example ```js @@ -2308,18 +2308,18 @@ welcome('curly'); -### `_.createCallback([func=identity, thisArg, argCount])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5266 "View in source") [Ⓣ][1] +### `_.createCallback([func=identity], [thisArg], [argCount])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5299 "View in source") [Ⓣ][1] Produces a callback bound to an optional `thisArg`. If `func` is a property name the created callback will return the property value for a given element. If `func` is an object the created callback will return `true` for elements that contain the equivalent object properties, otherwise it will return `false`. #### Arguments -1. `[func=identity]` *(Mixed)*: The value to convert to a callback. -2. `[thisArg]` *(Mixed)*: The `this` binding of the created callback. -3. `[argCount]` *(Number)*: The number of arguments the callback accepts. +1. `[func=identity]` *(\*)*: The value to convert to a callback. +2. `[thisArg]` *(\*)*: The `this` binding of the created callback. +3. `[argCount]` *(number)*: The number of arguments the callback accepts. #### Returns -*(Function)*: Returns a callback function. +*(function)*: Returns a callback function. #### Example ```js @@ -2347,17 +2347,17 @@ _.filter(stooges, 'age__gt45'); -### `_.curry(func [, arity=func.length])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5331 "View in source") [Ⓣ][1] +### `_.curry(func, [arity=func.length])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5364 "View in source") [Ⓣ][1] Creates a function which accepts one or more arguments of `func` that when invoked either executes `func` returning its result, if all `func` arguments have been provided, or returns a function that accepts one or more of the remaining `func` arguments, and so on. The arity of `func` can be specified if `func.length` is not sufficient. #### Arguments -1. `func` *(Function)*: The function to curry. -2. `[arity=func.length]` *(Number)*: The arity of `func`. +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 @@ -2383,19 +2383,19 @@ curried(1, 2, 3); ### `_.debounce(func, wait, options)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5375 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5408 "View in source") [Ⓣ][1] Creates a function that will delay the execution of `func` until after `wait` milliseconds have elapsed since the last time it was invoked. Provide an options object to indicate that `func` should be invoked on the leading and/or trailing edge of the `wait` timeout. Subsequent calls to the debounced function will return the result of the last `func` call. Note: If `leading` and `trailing` options are `true` `func` will be called on the trailing edge of the timeout only if the the debounced function is invoked more than once during the `wait` timeout. #### Arguments -1. `func` *(Function)*: The function to debounce. -2. `wait` *(Number)*: The number of milliseconds to delay. -3. `options` *(Object)*: The options object. [leading=false] A boolean to specify execution on the leading edge of the timeout. [maxWait] The maximum time `func` is allowed to be delayed before it's called. [trailing=true] A boolean to specify execution on the trailing edge of the timeout. +1. `func` *(function)*: The function to debounce. +2. `wait` *(number)*: The number of milliseconds to delay. +3. `options` *(object)*: The options object. [leading=false] A boolean to specify execution on the leading edge of the timeout. [maxWait] The maximum time `func` is allowed to be delayed before it's called. [trailing=true] A boolean to specify execution on the trailing edge of the timeout. #### Returns -*(Function)*: Returns the new debounced function. +*(function)*: Returns the new debounced function. #### Example ```js @@ -2423,17 +2423,17 @@ source.addEventListener('message', _.debounce(batchLog, 250, { -### `_.defer(func [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5473 "View in source") [Ⓣ][1] +### `_.defer(func, [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5511 "View in source") [Ⓣ][1] Defers executing the `func` function until the current call stack has cleared. Additional arguments will be provided to `func` when it is invoked. #### Arguments -1. `func` *(Function)*: The function to defer. -2. `[arg1, arg2, ...]` *(Mixed)*: Arguments to invoke the function with. +1. `func` *(function)*: The function to defer. +2. `[arg]` *(...\*)*: Arguments to invoke the function with. #### Returns -*(Number)*: Returns the timer id. +*(number)*: Returns the timer id. #### Example ```js @@ -2448,18 +2448,18 @@ _.defer(function() { console.log('deferred'); }); -### `_.delay(func, wait [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5507 "View in source") [Ⓣ][1] +### `_.delay(func, wait, [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5545 "View in source") [Ⓣ][1] Executes the `func` function after `wait` milliseconds. Additional arguments will be provided to `func` when it is invoked. #### Arguments -1. `func` *(Function)*: The function to delay. -2. `wait` *(Number)*: The number of milliseconds to delay execution. -3. `[arg1, arg2, ...]` *(Mixed)*: Arguments to invoke the function with. +1. `func` *(function)*: The function to delay. +2. `wait` *(number)*: The number of milliseconds to delay execution. +3. `[arg]` *(...\*)*: Arguments to invoke the function with. #### Returns -*(Number)*: Returns the timer id. +*(number)*: Returns the timer id. #### Example ```js @@ -2475,17 +2475,17 @@ _.delay(log, 1000, 'logged later'); -### `_.memoize(func [, resolver])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5549 "View in source") [Ⓣ][1] +### `_.memoize(func, [resolver])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5587 "View in source") [Ⓣ][1] Creates a function that memoizes the result of `func`. If `resolver` is provided it will be used to determine 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 cache key. The `func` is executed with the `this` binding of the memoized function. The result cache is exposed as the `cache` property on the memoized function. #### Arguments -1. `func` *(Function)*: The function to have its output memoized. -2. `[resolver]` *(Function)*: A function used to resolve the cache key. +1. `func` *(function)*: The function to have its output memoized. +2. `[resolver]` *(function)*: A function used to resolve the cache key. #### Returns -*(Function)*: Returns the new memoizing function. +*(function)*: Returns the new memoizing function. #### Example ```js @@ -2516,15 +2516,15 @@ stooge('curly'); ### `_.once(func)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5582 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5620 "View in source") [Ⓣ][1] Creates a function that is restricted to execute `func` once. Repeat calls to the function will return the value of the first call. The `func` is executed with the `this` binding of the created function. #### Arguments -1. `func` *(Function)*: The function to restrict. +1. `func` *(function)*: The function to restrict. #### Returns -*(Function)*: Returns the new restricted function. +*(function)*: Returns the new restricted function. #### Example ```js @@ -2541,17 +2541,17 @@ initialize(); -### `_.partial(func [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5620 "View in source") [Ⓣ][1] +### `_.partial(func, [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5658 "View in source") [Ⓣ][1] Creates a function that, when called, invokes `func` with any additional `partial` arguments prepended to those provided to the new function. This method is similar to `_.bind` except it does **not** alter the `this` binding. #### Arguments -1. `func` *(Function)*: The function to partially apply arguments to. -2. `[arg1, arg2, ...]` *(Mixed)*: Arguments to be partially applied. +1. `func` *(function)*: The function to partially apply arguments to. +2. `[arg]` *(...\*)*: Arguments to be partially applied. #### Returns -*(Function)*: Returns the new partially applied function. +*(function)*: Returns the new partially applied function. #### Example ```js @@ -2568,17 +2568,17 @@ hi('moe'); -### `_.partialRight(func [, arg1, arg2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5651 "View in source") [Ⓣ][1] +### `_.partialRight(func, [arg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5689 "View in source") [Ⓣ][1] This method is like `_.partial` except that `partial` arguments are appended to those provided to the new function. #### Arguments -1. `func` *(Function)*: The function to partially apply arguments to. -2. `[arg1, arg2, ...]` *(Mixed)*: Arguments to be partially applied. +1. `func` *(function)*: The function to partially apply arguments to. +2. `[arg]` *(...\*)*: Arguments to be partially applied. #### Returns -*(Function)*: Returns the new partially applied function. +*(function)*: Returns the new partially applied function. #### Example ```js @@ -2606,19 +2606,19 @@ options.imports ### `_.throttle(func, wait, options)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5686 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5724 "View in source") [Ⓣ][1] Creates a function that, when executed, will only call the `func` function at most once per every `wait` milliseconds. Provide an options object to indicate that `func` should be invoked on the leading and/or trailing edge of the `wait` timeout. Subsequent calls to the throttled function will return the result of the last `func` call. Note: If `leading` and `trailing` options are `true` `func` will be called on the trailing edge of the timeout only if the the throttled function is invoked more than once during the `wait` timeout. #### Arguments -1. `func` *(Function)*: The function to throttle. -2. `wait` *(Number)*: The number of milliseconds to throttle executions to. -3. `options` *(Object)*: The options object. [leading=true] A boolean to specify execution on the leading edge of the timeout. [trailing=true] A boolean to specify execution on the trailing edge of the timeout. +1. `func` *(function)*: The function to throttle. +2. `wait` *(number)*: The number of milliseconds to throttle executions to. +3. `options` *(object)*: The options object. [leading=true] A boolean to specify execution on the leading edge of the timeout. [trailing=true] A boolean to specify execution on the trailing edge of the timeout. #### Returns -*(Function)*: Returns the new throttled function. +*(function)*: Returns the new throttled function. #### Example ```js @@ -2640,16 +2640,16 @@ jQuery('.interactive').on('click', _.throttle(renewToken, 300000, { ### `_.wrap(value, wrapper)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5730 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5768 "View in source") [Ⓣ][1] Creates a function that provides `value` to the wrapper function as its first argument. Additional arguments provided to the function are appended to those provided to the wrapper function. The wrapper is executed with the `this` binding of the created function. #### Arguments -1. `value` *(Mixed)*: The value to wrap. -2. `wrapper` *(Function)*: The wrapper function. +1. `value` *(\*)*: The value to wrap. +2. `wrapper` *(function)*: The wrapper function. #### Returns -*(Function)*: Returns the new function. +*(function)*: Returns the new function. #### Example ```js @@ -2675,8 +2675,8 @@ hello(); -### `_.assign(object [, source1, source2, ..., callback, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1882 "View in source") [Ⓣ][1] +### `_.assign(object, [source], [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1907 "View in source") [Ⓣ][1] Assigns own enumerable properties of source object(s) to the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback is provided it will be executed to produce the assigned values. The callback is bound to `thisArg` and invoked with two arguments; *(objectValue, sourceValue)*. @@ -2684,13 +2684,13 @@ Assigns own enumerable properties of source object(s) to the destination object. *extend* #### Arguments -1. `object` *(Object)*: The destination object. -2. `[source1, source2, ...]` *(Object)*: The source objects. -3. `[callback]` *(Function)*: The function to customize assigning values. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The destination object. +2. `[source]` *(...object)*: The source objects. +3. `[callback]` *(function)*: The function to customize assigning values. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns the destination object. +*(object)*: Returns the destination object. #### Example ```js @@ -2713,19 +2713,19 @@ defaults(food, { 'name': 'banana', 'type': 'fruit' }); -### `_.clone(value [, deep=false, callback, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1935 "View in source") [Ⓣ][1] +### `_.clone(value, [deep=false], [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1960 "View in source") [Ⓣ][1] Creates a clone of `value`. If `deep` is `true` nested objects will also be cloned, otherwise they will be assigned by reference. If a callback is provided it will be executed to produce the cloned values. If the callback returns `undefined` cloning will be handled by the method instead. The callback is bound to `thisArg` and invoked with one argument; *(value)*. #### Arguments -1. `value` *(Mixed)*: The value to clone. -2. `[deep=false]` *(Boolean)*: A flag to indicate a deep clone. -3. `[callback]` *(Function)*: The function to customize cloning values. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `value` *(\*)*: The value to clone. +2. `[deep=false]` *(boolean)*: A flag to indicate a deep clone. +3. `[callback]` *(function)*: The function to customize cloning values. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the cloned `value`. +*(\*)*: Returns the cloned `value`. #### Example ```js @@ -2760,20 +2760,20 @@ clone.childNodes.length; -### `_.cloneDeep(value [, callback, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1987 "View in source") [Ⓣ][1] +### `_.cloneDeep(value, [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2012 "View in source") [Ⓣ][1] Creates a deep clone of `value`. If a callback is provided it will be executed to produce the cloned values. If the callback returns `undefined` cloning will be handled by the method instead. The callback is bound to `thisArg` and invoked with one argument; *(value)*. Note: This method is loosely based on the structured clone algorithm. Functions and DOM nodes are **not** cloned. The enumerable properties of `arguments` objects and objects created by constructors other than `Object` are cloned to plain `Object` objects. See http://www.w3.org/TR/html5/infrastructure.html#internal-structured-cloning-algorithm. #### Arguments -1. `value` *(Mixed)*: The value to deep clone. -2. `[callback]` *(Function)*: The function to customize cloning values. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `value` *(\*)*: The value to deep clone. +2. `[callback]` *(function)*: The function to customize cloning values. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the deep cloned `value`. +*(\*)*: Returns the deep cloned `value`. #### Example ```js @@ -2806,17 +2806,17 @@ clone.node == view.node; -### `_.defaults(object [, source1, source2, ...])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2011 "View in source") [Ⓣ][1] +### `_.defaults(object, [source])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2036 "View in source") [Ⓣ][1] Assigns own enumerable properties of source object(s) to the destination object for all destination properties that resolve to `undefined`. Once a property is set, additional defaults of the same property will be ignored. #### Arguments -1. `object` *(Object)*: The destination object. -2. `[source1, source2, ...]` *(Object)*: The source objects. +1. `object` *(object)*: The destination object. +2. `[source]` *(...object)*: The source objects. #### Returns -*(Object)*: Returns the destination object. +*(object)*: Returns the destination object. #### Example ```js @@ -2832,18 +2832,18 @@ _.defaults(food, { 'name': 'banana', 'type': 'fruit' }); -### `_.findKey(object [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2033 "View in source") [Ⓣ][1] +### `_.findKey(object, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2058 "View in source") [Ⓣ][1] This method is like `_.findIndex` except that it returns the key of the first element that passes the callback check, instead of the element itself. #### Arguments -1. `object` *(Object)*: The object to search. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The object to search. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the key of the found element, else `undefined`. +*(string, undefined)*: Returns the key of the found element, else `undefined`. #### Example ```js @@ -2860,18 +2860,18 @@ _.findKey({ 'a': 1, 'b': 2, 'c': 3, 'd': 4 }, function(num) { -### `_.findLastKey(object [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2065 "View in source") [Ⓣ][1] +### `_.findLastKey(object, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2090 "View in source") [Ⓣ][1] This method is like `_.findKey` except that it iterates over elements of a `collection` in the opposite order. #### Arguments -1. `object` *(Object)*: The object to search. -2. `[callback=identity]` *(Function|Object|String)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The object to search. +2. `[callback=identity]` *(function|object|string)*: The function called per iteration. If a property name or object is provided it will be used to create a "_.pluck" or "_.where" style callback, respectively. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the key of the found element, else `undefined`. +*(string, undefined)*: Returns the key of the found element, else `undefined`. #### Example ```js @@ -2888,18 +2888,18 @@ _.findLastKey({ 'a': 1, 'b': 2, 'c': 3, 'd': 4 }, function(num) { -### `_.forIn(object [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2106 "View in source") [Ⓣ][1] +### `_.forIn(object, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2131 "View in source") [Ⓣ][1] Iterates over own and inherited enumerable properties of an object, executing the callback for each property. The callback is bound to `thisArg` and invoked with three arguments; *(value, key, object)*. Callbacks may exit iteration early by explicitly returning `false`. #### Arguments -1. `object` *(Object)*: The object to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The object to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns `object`. +*(object)*: Returns `object`. #### Example ```js @@ -2924,18 +2924,18 @@ _.forIn(new Dog('Dagny'), function(value, key) { -### `_.forInRight(object [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2136 "View in source") [Ⓣ][1] +### `_.forInRight(object, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2161 "View in source") [Ⓣ][1] This method is like `_.forIn` except that it iterates over elements of a `collection` in the opposite order. #### Arguments -1. `object` *(Object)*: The object to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The object to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns `object`. +*(object)*: Returns `object`. #### Example ```js @@ -2960,18 +2960,18 @@ _.forInRight(new Dog('Dagny'), function(value, key) { -### `_.forOwn(object [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2174 "View in source") [Ⓣ][1] +### `_.forOwn(object, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2199 "View in source") [Ⓣ][1] Iterates over own enumerable properties of an object, executing the callback for each property. The callback is bound to `thisArg` and invoked with three arguments; *(value, key, object)*. Callbacks may exit iteration early by explicitly returning `false`. #### Arguments -1. `object` *(Object)*: The object to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The object to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns `object`. +*(object)*: Returns `object`. #### Example ```js @@ -2988,18 +2988,18 @@ _.forOwn({ '0': 'zero', '1': 'one', 'length': 2 }, function(num, key) { -### `_.forOwnRight(object [, callback=identity, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2194 "View in source") [Ⓣ][1] +### `_.forOwnRight(object, [callback=identity], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2219 "View in source") [Ⓣ][1] This method is like `_.forOwn` except that it iterates over elements of a `collection` in the opposite order. #### Arguments -1. `object` *(Object)*: The object to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The object to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns `object`. +*(object)*: Returns `object`. #### Example ```js @@ -3017,7 +3017,7 @@ _.forOwnRight({ '0': 'zero', '1': 'one', 'length': 2 }, function(num, key) { ### `_.functions(object)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2223 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2248 "View in source") [Ⓣ][1] Creates a sorted array of property names of all enumerable properties, own and inherited, of `object` that have function values. @@ -3025,10 +3025,10 @@ Creates a sorted array of property names of all enumerable properties, own and i *methods* #### Arguments -1. `object` *(Object)*: The object to inspect. +1. `object` *(object)*: The object to inspect. #### Returns -*(Array)*: Returns an array of property names that have function values. +*(array)*: Returns an array of property names that have function values. #### Example ```js @@ -3044,16 +3044,16 @@ _.functions(_); ### `_.has(object, property)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2248 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2273 "View in source") [Ⓣ][1] Checks if the specified object `property` exists and is a direct property, instead of an inherited property. #### Arguments -1. `object` *(Object)*: The object to check. -2. `property` *(String)*: The property to check for. +1. `object` *(object)*: The object to check. +2. `property` *(string)*: The property to check for. #### Returns -*(Boolean)*: Returns `true` if key is a direct property, else `false`. +*(boolean)*: Returns `true` if key is a direct property, else `false`. #### Example ```js @@ -3069,15 +3069,15 @@ _.has({ 'a': 1, 'b': 2, 'c': 3 }, 'b'); ### `_.invert(object)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2265 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2290 "View in source") [Ⓣ][1] Creates an object composed of the inverted keys and values of the given object. #### Arguments -1. `object` *(Object)*: The object to invert. +1. `object` *(object)*: The object to invert. #### Returns -*(Object)*: Returns the created inverted object. +*(object)*: Returns the created inverted object. #### Example ```js @@ -3093,15 +3093,15 @@ _.invert({ 'first': 'moe', 'second': 'larry' }); ### `_.isArguments(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1710 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1735 "View in source") [Ⓣ][1] Checks if `value` is an `arguments` object. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is an `arguments` object, else `false`. +*(boolean)*: Returns `true` if the `value` is an `arguments` object, else `false`. #### Example ```js @@ -3120,15 +3120,15 @@ _.isArguments([1, 2, 3]); ### `_.isArray(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1737 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1762 "View in source") [Ⓣ][1] Checks if `value` is an array. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is an array, else `false`. +*(boolean)*: Returns `true` if the `value` is an array, else `false`. #### Example ```js @@ -3147,15 +3147,15 @@ _.isArray([1, 2, 3]); ### `_.isBoolean(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2291 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2316 "View in source") [Ⓣ][1] Checks if `value` is a boolean value. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a boolean value, else `false`. +*(boolean)*: Returns `true` if the `value` is a boolean value, else `false`. #### Example ```js @@ -3171,15 +3171,15 @@ _.isBoolean(null); ### `_.isDate(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2308 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2333 "View in source") [Ⓣ][1] Checks if `value` is a date. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a date, else `false`. +*(boolean)*: Returns `true` if the `value` is a date, else `false`. #### Example ```js @@ -3195,15 +3195,15 @@ _.isDate(new Date); ### `_.isElement(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2325 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2350 "View in source") [Ⓣ][1] Checks if `value` is a DOM element. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a DOM element, else `false`. +*(boolean)*: Returns `true` if the `value` is a DOM element, else `false`. #### Example ```js @@ -3219,15 +3219,15 @@ _.isElement(document.body); ### `_.isEmpty(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2350 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2375 "View in source") [Ⓣ][1] Checks if `value` is empty. Arrays, strings, or `arguments` objects with a length of `0` and objects with no own enumerable properties are considered "empty". #### Arguments -1. `value` *(Array|Object|String)*: The value to inspect. +1. `value` *(array|object|string)*: The value to inspect. #### Returns -*(Boolean)*: Returns `true` if the `value` is empty, else `false`. +*(boolean)*: Returns `true` if the `value` is empty, else `false`. #### Example ```js @@ -3248,19 +3248,19 @@ _.isEmpty(''); -### `_.isEqual(a, b [, callback, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2407 "View in source") [Ⓣ][1] +### `_.isEqual(a, b, [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2432 "View in source") [Ⓣ][1] Performs a deep comparison between two values to determine if they are equivalent to each other. If a callback is provided it will be executed to compare values. If the callback returns `undefined` comparisons will be handled by the method instead. The callback is bound to `thisArg` and invoked with two arguments; *(a, b)*. #### Arguments -1. `a` *(Mixed)*: The value to compare. -2. `b` *(Mixed)*: The other value to compare. -3. `[callback]` *(Function)*: The function to customize comparing values. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `a` *(\*)*: The value to compare. +2. `b` *(\*)*: The other value to compare. +3. `[callback]` *(function)*: The function to customize comparing values. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Boolean)*: Returns `true` if the values are equivalent, else `false`. +*(boolean)*: Returns `true` if the values are equivalent, else `false`. #### Example ```js @@ -3294,17 +3294,17 @@ _.isEqual(words, otherWords, function(a, b) { ### `_.isFinite(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2439 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2464 "View in source") [Ⓣ][1] Checks if `value` is, or can be coerced to, a finite number. Note: This is not the same as native `isFinite` which will return true for booleans and empty strings. See http://es5.github.io/#x15.1.2.5. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is finite, else `false`. +*(boolean)*: Returns `true` if the `value` is finite, else `false`. #### Example ```js @@ -3332,15 +3332,15 @@ _.isFinite(Infinity); ### `_.isFunction(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2456 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2481 "View in source") [Ⓣ][1] Checks if `value` is a function. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a function, else `false`. +*(boolean)*: Returns `true` if the `value` is a function, else `false`. #### Example ```js @@ -3356,17 +3356,17 @@ _.isFunction(_); ### `_.isNaN(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2519 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2544 "View in source") [Ⓣ][1] Checks if `value` is `NaN`. Note: This is not the same as native `isNaN` which will return `true` for `undefined` and other non-numeric values. See http://es5.github.io/#x15.1.2.4. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is `NaN`, else `false`. +*(boolean)*: Returns `true` if the `value` is `NaN`, else `false`. #### Example ```js @@ -3391,15 +3391,15 @@ _.isNaN(undefined); ### `_.isNull(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2541 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2566 "View in source") [Ⓣ][1] Checks if `value` is `null`. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is `null`, else `false`. +*(boolean)*: Returns `true` if the `value` is `null`, else `false`. #### Example ```js @@ -3418,17 +3418,17 @@ _.isNull(undefined); ### `_.isNumber(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2560 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2585 "View in source") [Ⓣ][1] Checks if `value` is a number. Note: `NaN` is considered a number. See http://es5.github.io/#x8.5. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a number, else `false`. +*(boolean)*: Returns `true` if the `value` is a number, else `false`. #### Example ```js @@ -3444,15 +3444,15 @@ _.isNumber(8.4 * 5); ### `_.isObject(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2486 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2511 "View in source") [Ⓣ][1] Checks if `value` is the language type of Object. *(e.g. arrays, functions, objects, regexes, `new Number(0)`, and `new String('')`)* #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is an object, else `false`. +*(boolean)*: Returns `true` if the `value` is an object, else `false`. #### Example ```js @@ -3474,15 +3474,15 @@ _.isObject(1); ### `_.isPlainObject(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2588 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2613 "View in source") [Ⓣ][1] Checks if `value` is an object created by the `Object` constructor. #### Arguments -1. `value` *(Mixed)*: The value to check. +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 @@ -3509,15 +3509,15 @@ _.isPlainObject({ 'name': 'moe', 'age': 40 }); ### `_.isRegExp(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2613 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2638 "View in source") [Ⓣ][1] Checks if `value` is a regular expression. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a regular expression, else `false`. +*(boolean)*: Returns `true` if the `value` is a regular expression, else `false`. #### Example ```js @@ -3533,15 +3533,15 @@ _.isRegExp(/moe/); ### `_.isString(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2630 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2655 "View in source") [Ⓣ][1] Checks if `value` is a string. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is a string, else `false`. +*(boolean)*: Returns `true` if the `value` is a string, else `false`. #### Example ```js @@ -3557,15 +3557,15 @@ _.isString('moe'); ### `_.isUndefined(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2647 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2672 "View in source") [Ⓣ][1] Checks if `value` is `undefined`. #### Arguments -1. `value` *(Mixed)*: The value to check. +1. `value` *(\*)*: The value to check. #### Returns -*(Boolean)*: Returns `true` if the `value` is `undefined`, else `false`. +*(boolean)*: Returns `true` if the `value` is `undefined`, else `false`. #### Example ```js @@ -3581,15 +3581,15 @@ _.isUndefined(void 0); ### `_.keys(object)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1770 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1795 "View in source") [Ⓣ][1] Creates an array composed of the own enumerable property names of an object. #### Arguments -1. `object` *(Object)*: The object to inspect. +1. `object` *(object)*: The object to inspect. #### Returns -*(Array)*: Returns an array of property names. +*(array)*: Returns an array of property names. #### Example ```js @@ -3604,19 +3604,19 @@ _.keys({ 'one': 1, 'two': 2, 'three': 3 }); -### `_.merge(object [, source1, source2, ..., callback, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2702 "View in source") [Ⓣ][1] +### `_.merge(object, [source], [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2727 "View in source") [Ⓣ][1] Recursively merges own enumerable properties of the source object(s), that don't resolve to `undefined` into the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback is provided it will be executed to produce the merged values of the destination and source properties. If the callback returns `undefined` merging will be handled by the method instead. The callback is bound to `thisArg` and invoked with two arguments; *(objectValue, sourceValue)*. #### Arguments -1. `object` *(Object)*: The destination object. -2. `[source1, source2, ...]` *(Object)*: The source objects. -3. `[callback]` *(Function)*: The function to customize merging properties. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The destination object. +2. `[source]` *(...object)*: The source objects. +3. `[callback]` *(function)*: The function to customize merging properties. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns the destination object. +*(object)*: Returns the destination object. #### Example ```js @@ -3660,18 +3660,18 @@ _.merge(food, otherFood, function(a, b) { -### `_.omit(object, callback|[prop1, prop2, ..., thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2758 "View in source") [Ⓣ][1] +### `_.omit(object, [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2783 "View in source") [Ⓣ][1] Creates a shallow clone of `object` excluding the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback is provided it will be executed for each property of `object` omitting the properties the callback returns truthy for. The callback is bound to `thisArg` and invoked with three arguments; *(value, key, object)*. #### Arguments -1. `object` *(Object)*: The source object. -2. `callback|[prop1, prop2, ...]` *(Function|String)*: The properties to omit or the function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The source object. +2. `[callback]` *(function|...string|string[])*: The properties to omit or the function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns an object without the omitted properties. +*(object)*: Returns an object without the omitted properties. #### Example ```js @@ -3692,15 +3692,15 @@ _.omit({ 'name': 'moe', 'age': 40 }, function(value) { ### `_.pairs(object)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2793 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2818 "View in source") [Ⓣ][1] Creates a two dimensional array of an object's key-value pairs, i.e. `[[key1, value1], [key2, value2]]`. #### Arguments -1. `object` *(Object)*: The object to inspect. +1. `object` *(object)*: The object to inspect. #### Returns -*(Array)*: Returns new array of key-value pairs. +*(array)*: Returns new array of key-value pairs. #### Example ```js @@ -3715,18 +3715,18 @@ _.pairs({ 'moe': 30, 'larry': 40 }); -### `_.pick(object, callback|[prop1, prop2, ..., thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2833 "View in source") [Ⓣ][1] +### `_.pick(object, [callback], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2858 "View in source") [Ⓣ][1] Creates a shallow clone of `object` composed of the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback is provided it will be executed for each property of `object` picking the properties the callback returns truthy for. The callback is bound to `thisArg` and invoked with three arguments; *(value, key, object)*. #### Arguments -1. `object` *(Object)*: The source object. -2. `callback|[prop1, prop2, ...]` *(Array|Function|String)*: The function called per iteration or property names to pick, specified as individual property names or arrays of property names. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `object` *(object)*: The source object. +2. `[callback]` *(function|...string|string[])*: The function called per iteration or property names to pick, specified as individual property names or arrays of property names. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Object)*: Returns an object composed of the picked properties. +*(object)*: Returns an object composed of the picked properties. #### Example ```js @@ -3746,19 +3746,19 @@ _.pick({ 'name': 'moe', '_userid': 'moe1' }, function(value, key) { -### `_.transform(collection [, callback=identity, accumulator, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2888 "View in source") [Ⓣ][1] +### `_.transform(collection, [callback=identity], [accumulator], [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2913 "View in source") [Ⓣ][1] An alternative to `_.reduce` this method transforms `object` to a new `accumulator` object which is the result of running each of its elements through a callback, with each callback execution potentially mutating the `accumulator` object. The callback is bound to `thisArg` and invoked with four arguments; *(accumulator, value, key, object)*. Callbacks may exit iteration early by explicitly returning `false`. #### Arguments -1. `collection` *(Array|Object)*: The collection to iterate over. -2. `[callback=identity]` *(Function)*: The function called per iteration. -3. `[accumulator]` *(Mixed)*: The custom accumulator value. -4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `collection` *(array|object)*: The collection to iterate over. +2. `[callback=identity]` *(function)*: The function called per iteration. +3. `[accumulator]` *(\*)*: The custom accumulator value. +4. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Mixed)*: Returns the accumulated value. +*(\*)*: Returns the accumulated value. #### Example ```js @@ -3784,15 +3784,15 @@ var mapped = _.transform({ 'a': 1, 'b': 2, 'c': 3 }, function(result, num, key) ### `_.values(object)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2921 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L2946 "View in source") [Ⓣ][1] Creates an array composed of the own enumerable property values of `object`. #### Arguments -1. `object` *(Object)*: The object to inspect. +1. `object` *(object)*: The object to inspect. #### Returns -*(Array)*: Returns an array of property values. +*(array)*: Returns an array of property values. #### Example ```js @@ -3815,15 +3815,15 @@ _.values({ 'one': 1, 'two': 2, 'three': 3 }); ### `_.escape(string)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5757 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5795 "View in source") [Ⓣ][1] Converts the characters `&`, `<`, `>`, `"`, and `'` in `string` to their corresponding HTML entities. #### Arguments -1. `string` *(String)*: The string to escape. +1. `string` *(string)*: The string to escape. #### Returns -*(String)*: Returns the escaped string. +*(string)*: Returns the escaped string. #### Example ```js @@ -3839,15 +3839,15 @@ _.escape('Moe, Larry & Curly'); ### `_.identity(value)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5775 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5813 "View in source") [Ⓣ][1] This method returns the first argument provided to it. #### Arguments -1. `value` *(Mixed)*: Any value. +1. `value` *(\*)*: Any value. #### Returns -*(Mixed)*: Returns `value`. +*(\*)*: Returns `value`. #### Example ```js @@ -3864,13 +3864,13 @@ moe === _.identity(moe); ### `_.mixin(object, object)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5802 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5840 "View in source") [Ⓣ][1] Adds function properties of a source object to the `lodash` function and chainable wrapper. #### Arguments -1. `object` *(Object)*: The object of function properties to add to `lodash`. -2. `object` *(Object)*: The object of function properties to add to `lodash`. +1. `object` *(object)*: The object of function properties to add to `lodash`. +2. `object` *(object)*: The object of function properties to add to `lodash`. #### Example ```js @@ -3895,12 +3895,12 @@ _('moe').capitalize(); ### `_.noConflict()` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5840 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5878 "View in source") [Ⓣ][1] Reverts the '_' variable to its previous value and returns a reference to the `lodash` function. #### Returns -*(Function)*: Returns the `lodash` function. +*(function)*: Returns the `lodash` function. #### Example ```js @@ -3914,19 +3914,19 @@ var lodash = _.noConflict(); -### `_.parseInt(value [, radix])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5864 "View in source") [Ⓣ][1] +### `_.parseInt(value, [radix])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5902 "View in source") [Ⓣ][1] Converts the given `value` into an integer of the specified `radix`. If `radix` is `undefined` or `0` a `radix` of `10` is used unless the `value` is a hexadecimal, in which case a `radix` of `16` is used. Note: This method avoids differences in native ES3 and ES5 `parseInt` implementations. See http://es5.github.io/#E. #### Arguments -1. `value` *(String)*: The value to parse. -2. `[radix]` *(Number)*: The radix used to interpret the value to parse. +1. `value` *(string)*: The value to parse. +2. `[radix]` *(number)*: The radix used to interpret the value to parse. #### Returns -*(Number)*: Returns the new integer value. +*(number)*: Returns the new integer value. #### Example ```js @@ -3941,17 +3941,17 @@ _.parseInt('08'); -### `_.random([min=0, max=1])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5888 "View in source") [Ⓣ][1] +### `_.random([min=0], [max=1])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5926 "View in source") [Ⓣ][1] Produces a random number between `min` and `max` *(inclusive)*. If only one argument is provided a number between `0` and the given number will be returned. #### Arguments -1. `[min=0]` *(Number)*: The minimum possible value. -2. `[max=1]` *(Number)*: The maximum possible value. +1. `[min=0]` *(number)*: The minimum possible value. +2. `[max=1]` *(number)*: The maximum possible value. #### Returns -*(Number)*: Returns a random number. +*(number)*: Returns a random number. #### Example ```js @@ -3970,16 +3970,16 @@ _.random(5); ### `_.result(object, property)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5932 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5970 "View in source") [Ⓣ][1] Resolves the value of `property` on `object`. If `property` is a function it will be invoked with the `this` binding of `object` and its result returned, else the property value is returned. If `object` is falsey then `undefined` is returned. #### Arguments -1. `object` *(Object)*: The object to inspect. -2. `property` *(String)*: The property to get the value of. +1. `object` *(object)*: The object to inspect. +2. `property` *(string)*: The property to get the value of. #### Returns -*(Mixed)*: Returns the resolved value. +*(\*)*: Returns the resolved value. #### Example ```js @@ -4010,10 +4010,10 @@ _.result(object, 'stuff'); Create a new `lodash` function using the given `context` object. #### Arguments -1. `[context=root]` *(Object)*: The context object. +1. `[context=root]` *(object)*: The context object. #### Returns -*(Function)*: Returns the `lodash` function. +*(function)*: Returns the `lodash` function. * * * @@ -4023,7 +4023,7 @@ Create a new `lodash` function using the given `context` object. ### `_.template(text, data, options)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6023 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6061 "View in source") [Ⓣ][1] A micro-templating method that handles arbitrary delimiters, preserves whitespace, and correctly escapes quotes within interpolated code. @@ -4036,12 +4036,12 @@ For more information on Chrome extension sandboxes see:
http://developer.chrome.com/stable/extensions/sandboxingEval.html #### Arguments -1. `text` *(String)*: The template text. -2. `data` *(Object)*: The data object used to populate the text. -3. `options` *(Object)*: The options object. escape - The "escape" delimiter regexp. evaluate - The "evaluate" delimiter regexp. imports - An object of properties to import into the compiled template as local variables. interpolate - The "interpolate" delimiter regexp. sourceURL - The sourceURL of the template's compiled source. variable - The data object variable name. +1. `text` *(string)*: The template text. +2. `data` *(object)*: The data object used to populate the text. +3. `options` *(object)*: The options object. escape - The "escape" delimiter regexp. evaluate - The "evaluate" delimiter regexp. imports - An object of properties to import into the compiled template as local variables. interpolate - The "interpolate" delimiter regexp. sourceURL - The sourceURL of the template's compiled source. variable - The data object variable name. #### Returns -*(Function, String)*: Returns a compiled function when no `data` object is given, else it returns the interpolated text. +*((function, string)*): Returns a compiled function when no `data` object is given, else it returns the interpolated text. #### Example ```js @@ -4110,18 +4110,18 @@ fs.writeFileSync(path.join(cwd, 'jst.js'), '\ -### `_.times(n, callback [, thisArg])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6148 "View in source") [Ⓣ][1] +### `_.times(n, callback, [thisArg])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6186 "View in source") [Ⓣ][1] Executes the callback `n` times, returning an array of the results of each callback execution. The callback is bound to `thisArg` and invoked with one argument; *(index)*. #### Arguments -1. `n` *(Number)*: The number of times to execute the callback. -2. `callback` *(Function)*: The function called per iteration. -3. `[thisArg]` *(Mixed)*: The `this` binding of `callback`. +1. `n` *(number)*: The number of times to execute the callback. +2. `callback` *(function)*: The function called per iteration. +3. `[thisArg]` *(\*)*: The `this` binding of `callback`. #### Returns -*(Array)*: Returns an array of the results of each `callback` execution. +*(array)*: Returns an array of the results of each `callback` execution. #### Example ```js @@ -4143,15 +4143,15 @@ _.times(3, function(n) { this.cast(n); }, mage); ### `_.unescape(string)` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6175 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6213 "View in source") [Ⓣ][1] The inverse of `_.escape` this method converts the HTML entities `&`, `<`, `>`, `"`, and `'` in `string` to their corresponding characters. #### Arguments -1. `string` *(String)*: The string to unescape. +1. `string` *(string)*: The string to unescape. #### Returns -*(String)*: Returns the unescaped string. +*(string)*: Returns the unescaped string. #### Example ```js @@ -4167,15 +4167,15 @@ _.unescape('Moe, Larry & Curly'); ### `_.uniqueId([prefix])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6195 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6233 "View in source") [Ⓣ][1] Generates a unique ID. If `prefix` is provided the ID will be appended to it. #### Arguments -1. `[prefix]` *(String)*: The value to prefix the ID with. +1. `[prefix]` *(string)*: The value to prefix the ID with. #### Returns -*(String)*: Returns the unique ID. +*(string)*: Returns the unique ID. #### Example ```js @@ -4201,7 +4201,7 @@ _.uniqueId(); ### `_.templateSettings.imports._` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L831 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L839 "View in source") [Ⓣ][1] A reference to the `lodash` function. @@ -4220,9 +4220,9 @@ A reference to the `lodash` function. ### `_.VERSION` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6504 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L6542 "View in source") [Ⓣ][1] -*(String)*: The semantic version number. +*(string)*: The semantic version number. * * * @@ -4232,9 +4232,9 @@ A reference to the `lodash` function. ### `_.support` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L649 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L657 "View in source") [Ⓣ][1] -*(Object)*: An object used to flag environments features. +*(object)*: An object used to flag environments features. * * * @@ -4244,9 +4244,9 @@ A reference to the `lodash` function. ### `_.support.argsClass` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L674 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L682 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if an `arguments` object's [[Class]] is resolvable *(all but Firefox < `4`, IE < `9`)*. +*(boolean)*: Detect if an `arguments` object's [[Class]] is resolvable *(all but Firefox < `4`, IE < `9`)*. * * * @@ -4256,9 +4256,9 @@ A reference to the `lodash` function. ### `_.support.argsObject` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L666 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L674 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if `arguments` objects are `Object` objects *(all but Narwhal and Opera < `10.5`)*. +*(boolean)*: Detect if `arguments` objects are `Object` objects *(all but Narwhal and Opera < `10.5`)*. * * * @@ -4268,9 +4268,9 @@ A reference to the `lodash` function. ### `_.support.enumErrorProps` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L683 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L691 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if `name` or `message` properties of `Error.prototype` are enumerable by default. *(IE < `9`, Safari < `5.1`)* +*(boolean)*: Detect if `name` or `message` properties of `Error.prototype` are enumerable by default. *(IE < `9`, Safari < `5.1`)* * * * @@ -4280,9 +4280,9 @@ A reference to the `lodash` function. ### `_.support.enumPrototypes` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L696 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L704 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if `prototype` properties are enumerable by default. +*(boolean)*: Detect if `prototype` properties are enumerable by default. Firefox < `3.6`, Opera > `9.50` - Opera < `11.60`, and Safari < `5.1` *(if the prototype or a property on the prototype has been set)* incorrectly sets a function's `prototype` property [[Enumerable]] value to `true`. @@ -4294,9 +4294,9 @@ Firefox < `3.6`, Opera > `9.50` - Opera < `11.60`, and Safari < `5.1` *(if the p ### `_.support.fastBind` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L704 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L712 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if `Function#bind` exists and is inferred to be fast *(all but V8)*. +*(boolean)*: Detect if `Function#bind` exists and is inferred to be fast *(all but V8)*. * * * @@ -4306,9 +4306,9 @@ Firefox < `3.6`, Opera > `9.50` - Opera < `11.60`, and Safari < `5.1` *(if the p ### `_.support.nonEnumArgs` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L721 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L729 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if `arguments` object indexes are non-enumerable *(Firefox < `4`, IE < `9`, PhantomJS, Safari < `5.1`)*. +*(boolean)*: Detect if `arguments` object indexes are non-enumerable *(Firefox < `4`, IE < `9`, PhantomJS, Safari < `5.1`)*. * * * @@ -4318,9 +4318,9 @@ Firefox < `3.6`, Opera > `9.50` - Opera < `11.60`, and Safari < `5.1` *(if the p ### `_.support.nonEnumShadows` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L732 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L740 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if properties shadowing those on `Object.prototype` are non-enumerable. +*(boolean)*: Detect if properties shadowing those on `Object.prototype` are non-enumerable. In IE < `9` an objects own properties, shadowing non-enumerable ones, are made non-enumerable as well *(a.k.a the JScript [[DontEnum]] bug)*. @@ -4332,9 +4332,9 @@ In IE < `9` an objects own properties, shadowing non-enumerable ones, are made n ### `_.support.ownLast` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L712 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L720 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if own properties are iterated after inherited properties *(all but IE < `9`)*. +*(boolean)*: Detect if own properties are iterated after inherited properties *(all but IE < `9`)*. * * * @@ -4344,9 +4344,9 @@ In IE < `9` an objects own properties, shadowing non-enumerable ones, are made n ### `_.support.spliceObjects` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L746 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L754 "View in source") [Ⓣ][1] -*(Boolean)*: Detect if `Array#shift` and `Array#splice` augment array-like objects correctly. +*(boolean)*: Detect if `Array#shift` and `Array#splice` augment array-like objects correctly. Firefox < `10`, IE compatibility mode, and IE < `9` have buggy Array `shift()` and `splice()` functions that fail to remove the last element, `value[0]`, of array-like objects even though the `length` property is set to `0`. The `shift()` method is buggy in IE `8` compatibility mode, while `splice()` is buggy regardless of mode in IE < `9` and buggy in compatibility mode in IE `9`. @@ -4358,9 +4358,9 @@ Firefox < `10`, IE compatibility mode, and IE < `9` have buggy Array `shift()` a ### `_.support.unindexedChars` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L757 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L765 "View in source") [Ⓣ][1] -*(Boolean)*: Detect lack of support for accessing string characters by index. +*(boolean)*: Detect lack of support for accessing string characters by index. IE < `8` can't access characters by index and IE `8` can only access characters by index on string literals. @@ -4372,9 +4372,9 @@ IE < `8` can't access characters by index and IE `8` can only access characters ### `_.templateSettings` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L783 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L791 "View in source") [Ⓣ][1] -*(Object)*: By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby *(ERB)*. Change the following template settings to use alternative delimiters. +*(object)*: By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby *(ERB)*. Change the following template settings to use alternative delimiters. * * * @@ -4384,9 +4384,9 @@ IE < `8` can't access characters by index and IE `8` can only access characters ### `_.templateSettings.escape` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L791 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L799 "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. * * * @@ -4396,9 +4396,9 @@ IE < `8` can't access characters by index and IE `8` can only access characters ### `_.templateSettings.evaluate` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L799 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L807 "View in source") [Ⓣ][1] -*(RegExp)*: Used to detect code to be evaluated. +*(regexp)*: Used to detect code to be evaluated. * * * @@ -4408,9 +4408,9 @@ IE < `8` can't access characters by index and IE `8` can only access characters ### `_.templateSettings.interpolate` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L807 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L815 "View in source") [Ⓣ][1] -*(RegExp)*: Used to detect `data` property values to inject. +*(regexp)*: Used to detect `data` property values to inject. * * * @@ -4420,9 +4420,9 @@ IE < `8` can't access characters by index and IE `8` can only access characters ### `_.templateSettings.variable` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L815 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L823 "View in source") [Ⓣ][1] -*(String)*: Used to reference the data object in the template text. +*(string)*: Used to reference the data object in the template text. * * * @@ -4432,9 +4432,9 @@ IE < `8` can't access characters by index and IE `8` can only access characters ### `_.templateSettings.imports` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L823 "View in source") [Ⓣ][1] +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L831 "View in source") [Ⓣ][1] -*(Object)*: Used to import variables into the compiled template. +*(object)*: Used to import variables into the compiled template. * * * diff --git a/vendor/docdown/docdown.php b/vendor/docdown/docdown.php index 59b4ef549..e933e0a10 100644 --- a/vendor/docdown/docdown.php +++ b/vendor/docdown/docdown.php @@ -9,8 +9,8 @@ require(dirname(__FILE__) . '/src/DocDown/MarkdownGenerator.php'); /** * Generates Markdown from JSDoc entries in a given file. * - * @param {Array} [$options=array()] The options array. - * @returns {String} The generated Markdown. + * @param {array} [$options=array()] The options array. + * @returns {string} The generated Markdown. * @example * * // specify a file path diff --git a/vendor/docdown/src/DocDown/Alias.php b/vendor/docdown/src/DocDown/Alias.php index 0a7c552e0..65ba4f755 100644 --- a/vendor/docdown/src/DocDown/Alias.php +++ b/vendor/docdown/src/DocDown/Alias.php @@ -19,8 +19,8 @@ class Alias { * The Alias constructor. * * @constructor - * @param {String} $name The alias name. - * @param {Object} $owner The alias owner. + * @param {string} $name The alias name. + * @param {object} $owner The alias owner. */ public function __construct( $name, $owner ) { $this->owner = $owner; @@ -47,8 +47,8 @@ class Alias { * Extracts the entry's `alias` objects. * * @memberOf Alias - * @param {Number} $index The index of the array value to return. - * @returns {Array|String} The entry's `alias` objects. + * @param {number} $index The index of the array value to return. + * @returns {(array|string)} The entry's `alias` objects. */ public function getAliases( $index = null ) { $result = array(); @@ -61,7 +61,7 @@ class Alias { * Extracts the function call from the owner entry. * * @memberOf Alias - * @returns {String} The function call. + * @returns {string} The function call. */ public function getCall() { return $this->_call; @@ -71,7 +71,7 @@ class Alias { * Extracts the owner entry's `category` data. * * @memberOf Alias - * @returns {String} The owner entry's `category` data. + * @returns {string} The owner entry's `category` data. */ public function getCategory() { return $this->_category; @@ -81,7 +81,7 @@ class Alias { * Extracts the owner entry's description. * * @memberOf Alias - * @returns {String} The owner entry's description. + * @returns {string} The owner entry's description. */ public function getDesc() { return $this->_desc; @@ -91,7 +91,7 @@ class Alias { * Extracts the owner entry's `example` data. * * @memberOf Alias - * @returns {String} The owner entry's `example` data. + * @returns {string} The owner entry's `example` data. */ public function getExample() { return $this->_example; @@ -101,7 +101,7 @@ class Alias { * Checks if the entry is an alias. * * @memberOf Alias - * @returns {Boolean} Returns `true`. + * @returns {boolean} Returns `true`. */ public function isAlias() { return true; @@ -111,7 +111,7 @@ class Alias { * Checks if the owner entry is a constructor. * * @memberOf Alias - * @returns {Boolean} Returns `true` if a constructor, else `false`. + * @returns {boolean} Returns `true` if a constructor, else `false`. */ public function isCtor() { return $this->_isCtor; @@ -121,7 +121,7 @@ class Alias { * Checks if the owner entry is a license. * * @memberOf Alias - * @returns {Boolean} Returns `true` if a license, else `false`. + * @returns {boolean} Returns `true` if a license, else `false`. */ public function isLicense() { return $this->_isLicense; @@ -131,7 +131,7 @@ class Alias { * Checks if the owner entry *is* assigned to a prototype. * * @memberOf Alias - * @returns {Boolean} Returns `true` if assigned to a prototype, else `false`. + * @returns {boolean} Returns `true` if assigned to a prototype, else `false`. */ public function isPlugin() { return $this->_isPlugin; @@ -141,7 +141,7 @@ class Alias { * Checks if the owner entry is private. * * @memberOf Alias - * @returns {Boolean} Returns `true` if private, else `false`. + * @returns {boolean} Returns `true` if private, else `false`. */ public function isPrivate() { return $this->_isPrivate; @@ -151,7 +151,7 @@ class Alias { * Checks if the owner entry is *not* assigned to a prototype. * * @memberOf Alias - * @returns {Boolean} Returns `true` if not assigned to a prototype, else `false`. + * @returns {boolean} Returns `true` if not assigned to a prototype, else `false`. */ public function isStatic() { return $this->_isStatic; @@ -161,7 +161,7 @@ class Alias { * Resolves the owner entry's line number. * * @memberOf Alias - * @returns {Number} The owner entry's line number. + * @returns {number} The owner entry's line number. */ public function getLineNumber() { return $this->_lineNumber; @@ -171,8 +171,8 @@ class Alias { * Extracts the owner entry's `member` data. * * @memberOf Alias - * @param {Number} $index The index of the array value to return. - * @returns {Array|String} The owner entry's `member` data. + * @param {number} $index The index of the array value to return. + * @returns {(array|string)} The owner entry's `member` data. */ public function getMembers( $index = null ) { return $index !== null @@ -184,7 +184,7 @@ class Alias { * Extracts the owner entry's `name` data. * * @memberOf Alias - * @returns {String} The owner entry's `name` data. + * @returns {string} The owner entry's `name` data. */ public function getName() { return $this->_name; @@ -194,8 +194,8 @@ class Alias { * Extracts the owner entry's `param` data. * * @memberOf Alias - * @param {Number} $index The index of the array value to return. - * @returns {Array} The owner entry's `param` data. + * @param {number} $index The index of the array value to return. + * @returns {array} The owner entry's `param` data. */ public function getParams( $index = null ) { return $index !== null @@ -207,7 +207,7 @@ class Alias { * Extracts the owner entry's `returns` data. * * @memberOf Alias - * @returns {String} The owner entry's `returns` data. + * @returns {string} The owner entry's `returns` data. */ public function getReturns() { return $this->_returns; @@ -217,7 +217,7 @@ class Alias { * Extracts the owner entry's `type` data. * * @memberOf Alias - * @returns {String} The owner entry's `type` data. + * @returns {string} The owner entry's `type` data. */ public function getType() { return $this->_type; diff --git a/vendor/docdown/src/DocDown/Entry.php b/vendor/docdown/src/DocDown/Entry.php index a973d9a67..51a8ebb0a 100644 --- a/vendor/docdown/src/DocDown/Entry.php +++ b/vendor/docdown/src/DocDown/Entry.php @@ -11,7 +11,7 @@ class Entry { * The documentation entry. * * @memberOf Entry - * @type String + * @type string */ public $entry = ''; @@ -19,7 +19,7 @@ class Entry { * The language highlighter used for code examples. * * @memberOf Entry - * @type String + * @type string */ public $lang = ''; @@ -27,7 +27,7 @@ class Entry { * The source code. * * @memberOf Entry - * @type String + * @type string */ public $source = ''; @@ -37,9 +37,9 @@ class Entry { * The Entry constructor. * * @constructor - * @param {String} $entry The documentation entry to analyse. - * @param {String} $source The source code. - * @param {String} [$lang ='js'] The language highlighter used for code examples. + * @param {string} $entry The documentation entry to analyse. + * @param {string} $source The source code. + * @param {string} [$lang ='js'] The language highlighter used for code examples. */ public function __construct( $entry, $source, $lang = 'js' ) { $this->entry = $entry; @@ -54,8 +54,8 @@ class Entry { * * @static * @memberOf Entry - * @param {String} $source The source code. - * @returns {Array} The array of entries. + * @param {string} $source The source code. + * @returns {array} The array of entries. */ public static function getEntries( $source ) { preg_match_all('#/\*\*(?![-!])[\s\S]*?\*/\s*.+#', $source, $result); @@ -69,7 +69,7 @@ class Entry { * * @private * @memberOf Entry - * @returns {Boolean} Returns `true` if the entry is a function reference, else `false`. + * @returns {boolean} Returns `true` if the entry is a function reference, else `false`. */ private function isFunction() { if (!isset($this->_isFunction)) { @@ -89,8 +89,8 @@ class Entry { * Extracts the entry's `alias` objects. * * @memberOf Entry - * @param {Number} $index The index of the array value to return. - * @returns {Array|String} The entry's `alias` objects. + * @param {number} $index The index of the array value to return. + * @returns {(array|string)} The entry's `alias` objects. */ public function getAliases( $index = null ) { if (!isset($this->_aliases)) { @@ -116,7 +116,7 @@ class Entry { * Extracts the function call from the entry. * * @memberOf Entry - * @returns {String} The function call. + * @returns {string} The function call. */ public function getCall() { if (isset($this->_call)) { @@ -140,12 +140,12 @@ class Entry { // compose parts $result = array($result); $params = $this->getParams(); + foreach ($params as $param) { $result[] = $param[1]; } // format $result = $name .'('. implode(array_slice($result, 1), ', ') .')'; - $result = str_replace(', [', ' [, ', str_replace('], [', ', ', $result)); } $this->_call = $result ? $result : $name; @@ -156,7 +156,7 @@ class Entry { * Extracts the entry's `category` data. * * @memberOf Entry - * @returns {String} The entry's `category` data. + * @returns {string} The entry's `category` data. */ public function getCategory() { if (isset($this->_category)) { @@ -167,7 +167,7 @@ class Entry { if (count($result)) { $result = trim(preg_replace('/(?:^|\n)[\t ]*\*[\t ]?/', ' ', $result[1])); } else { - $result = $this->getType() == 'Function' ? 'Methods' : 'Properties'; + $result = $this->getType() == 'function' ? 'Methods' : 'Properties'; } $this->_category = $result; return $result; @@ -177,7 +177,7 @@ class Entry { * Extracts the entry's description. * * @memberOf Entry - * @returns {String} The entry's description. + * @returns {string} The entry's description. */ public function getDesc() { if (isset($this->_desc)) { @@ -191,7 +191,7 @@ class Entry { $result = preg_replace('/(?:^|\n)[\t ]*\*\n[\t ]*\*[\t ]*/', "\n\n", $result); $result = preg_replace('/(?:^|\n)[\t ]*\*[\t ]?/', ' ', $result); $result = trim($result); - $result = ($type == 'Function' ? '' : '(' . str_replace('|', ', ', trim($type, '{}')) . '): ') . $result; + $result = ($type == 'function' ? '' : '(' . str_replace('|', ', ', trim($type, '{}')) . '): ') . $result; } $this->_desc = $result; return $result; @@ -201,7 +201,7 @@ class Entry { * Extracts the entry's `example` data. * * @memberOf Entry - * @returns {String} The entry's `example` data. + * @returns {string} The entry's `example` data. */ public function getExample() { if (isset($this->_example)) { @@ -221,7 +221,7 @@ class Entry { * Checks if the entry is an alias. * * @memberOf Entry - * @returns {Boolean} Returns `false`. + * @returns {boolean} Returns `false`. */ public function isAlias() { return false; @@ -231,7 +231,7 @@ class Entry { * Checks if the entry is a constructor. * * @memberOf Entry - * @returns {Boolean} Returns `true` if a constructor, else `false`. + * @returns {boolean} Returns `true` if a constructor, else `false`. */ public function isCtor() { if (!isset($this->_isCtor)) { @@ -244,7 +244,7 @@ class Entry { * Checks if the entry is a license. * * @memberOf Entry - * @returns {Boolean} Returns `true` if a license, else `false`. + * @returns {boolean} Returns `true` if a license, else `false`. */ public function isLicense() { if (!isset($this->_isLicense)) { @@ -257,7 +257,7 @@ class Entry { * Checks if the entry *is* assigned to a prototype. * * @memberOf Entry - * @returns {Boolean} Returns `true` if assigned to a prototype, else `false`. + * @returns {boolean} Returns `true` if assigned to a prototype, else `false`. */ public function isPlugin() { if (!isset($this->_isPlugin)) { @@ -270,7 +270,7 @@ class Entry { * Checks if the entry is private. * * @memberOf Entry - * @returns {Boolean} Returns `true` if private, else `false`. + * @returns {boolean} Returns `true` if private, else `false`. */ public function isPrivate() { if (!isset($this->_isPrivate)) { @@ -283,7 +283,7 @@ class Entry { * Checks if the entry is *not* assigned to a prototype. * * @memberOf Entry - * @returns {Boolean} Returns `true` if not assigned to a prototype, else `false`. + * @returns {boolean} Returns `true` if not assigned to a prototype, else `false`. */ public function isStatic() { if (isset($this->_isStatic)) { @@ -315,7 +315,7 @@ class Entry { * Resolves the entry's line number. * * @memberOf Entry - * @returns {Number} The entry's line number. + * @returns {number} The entry's line number. */ public function getLineNumber() { if (!isset($this->_lineNumber)) { @@ -329,8 +329,8 @@ class Entry { * Extracts the entry's `member` data. * * @memberOf Entry - * @param {Number} $index The index of the array value to return. - * @returns {Array|String} The entry's `member` data. + * @param {number} $index The index of the array value to return. + * @returns {(array|string)} The entry's `member` data. */ public function getMembers( $index = null ) { if (!isset($this->_members)) { @@ -351,7 +351,7 @@ class Entry { * Extracts the entry's `name` data. * * @memberOf Entry - * @returns {String} The entry's `name` data. + * @returns {string} The entry's `name` data. */ public function getName() { if (isset($this->_name)) { @@ -372,23 +372,26 @@ class Entry { * Extracts the entry's `param` data. * * @memberOf Entry - * @param {Number} $index The index of the array value to return. - * @returns {Array} The entry's `param` data. + * @param {number} $index The index of the array value to return. + * @returns {array} The entry's `param` data. */ public function getParams( $index = null ) { if (!isset($this->_params)) { - preg_match_all('#\*[\t ]*@param\s+\{([^}]+)\}\s+(\[.+\]|[$\w|]+(?:\[.+\])?)\s+([\s\S]*?)(?=\*\s\@[a-z]|\*/)#i', $this->entry, $result); - if (count($result = array_filter(array_slice($result, 1)))) { - // repurpose array - foreach ($result as $param) { - foreach ($param as $key => $value) { - if (!is_array($result[0][$key])) { - $result[0][$key] = array(); + preg_match_all('#\*[\t ]*@param\s+\{\(?([^})]+)\)?\}\s+(\[.+\]|[$\w|]+(?:\[.+\])?)\s+([\s\S]*?)(?=\*\s\@[a-z]|\*/)#i', $this->entry, $matchTuples); + $matchTuples = array_filter(array_slice($matchTuples, 1)); + $result = array(); + + if (count($matchTuples)) { + foreach ($matchTuples as $tupleKey => $tuple) { + foreach ($tuple as $key => $value) { + if (!isset($result[$key])) { + $result[$key] = array(); } - $result[0][$key][] = trim(preg_replace('/(?:^|\n)[\t ]*\*[\t ]*/', ' ', $value)); + $result[$key][] = $tupleKey + ? trim(preg_replace('/(?:^|\n)[\t ]*\*[\t ]*/', ' ', $value)) + : trim($value); } } - $result = $result[0]; } $this->_params = $result; } @@ -401,7 +404,7 @@ class Entry { * Extracts the entry's `returns` data. * * @memberOf Entry - * @returns {String} The entry's `returns` data. + * @returns {string} The entry's `returns` data. */ public function getReturns() { if (isset($this->_returns)) { @@ -422,18 +425,18 @@ class Entry { * Extracts the entry's `type` data. * * @memberOf Entry - * @returns {String} The entry's `type` data. + * @returns {string} The entry's `type` data. */ public function getType() { if (isset($this->_type)) { return $this->_type; } - preg_match('#\*[\t ]*@type\s+(.+)#', $this->entry, $result); + preg_match('#\*[\t ]*@type\s(?:\{\(?)?([^)}\n]+)#', $this->entry, $result); if (count($result)) { - $result = trim(preg_replace('/(?:^|\n)[\t ]*\*[\t ]?/', ' ', $result[1])); + $result = trim(strtolower($result[1])); } else { - $result = $this->isFunction() ? 'Function' : 'Unknown'; + $result = $this->isFunction() ? 'function' : 'unknown'; } $this->_type = $result; return $result; diff --git a/vendor/docdown/src/DocDown/MarkdownGenerator.php b/vendor/docdown/src/DocDown/MarkdownGenerator.php index 025dc99d9..10ccdf7a8 100644 --- a/vendor/docdown/src/DocDown/MarkdownGenerator.php +++ b/vendor/docdown/src/DocDown/MarkdownGenerator.php @@ -12,7 +12,7 @@ class MarkdownGenerator { * * @static * @memberOf MarkdownGenerator - * @type String + * @type string */ public $closeTag = "\n\n"; @@ -29,7 +29,7 @@ class MarkdownGenerator { * * @static * @memberOf MarkdownGenerator - * @type String + * @type string */ public $openTag = "\n\n"; @@ -45,7 +45,7 @@ class MarkdownGenerator { * The file's source code. * * @memberOf MarkdownGenerator - * @type String + * @type string */ public $source = ''; @@ -55,8 +55,8 @@ class MarkdownGenerator { * The MarkdownGenerator constructor. * * @constructor - * @param {String} $source The source code to parse. - * @param {Array} $options The options array. + * @param {string} $source The source code to parse. + * @param {array} $options The options array. */ public function __construct( $source, $options = array() ) { // juggle arguments @@ -104,8 +104,8 @@ class MarkdownGenerator { * @private * @static * @memberOf MarkdownGenerator - * @param {String} $string The string to format. - * @returns {String} The formatted string. + * @param {string} $string The string to format. + * @returns {string} The formatted string. */ private static function format( $string ) { $counter = 0; @@ -138,22 +138,22 @@ class MarkdownGenerator { * @private * @static * @memberOf MarkdownGenerator - * @param {String} $string The string to modify. - * @param {Array|Object} $object The template object. - * @returns {String} The modified string. + * @param {string} $string The string to modify. + * @param {(array|object)} $object The template object. + * @returns {string} The modified string. */ private static function interpolate( $string, $object ) { preg_match_all('/#\{([^}]+)\}/', $string, $tokens); $tokens = array_unique(array_pop($tokens)); foreach ($tokens as $token) { - $pattern = '/#\{' . $token . '\}/'; + $pattern = '/#\{' . preg_replace('/([.*+?^${}()|[\]\\\])/', '\\\$1', $token) . '\}/'; $replacement = ''; if (is_object($object)) { preg_match('/\(([^)]+?)\)$/', $token, $args); $args = preg_split('/,\s*/', array_pop($args)); - $method = 'get' . ucfirst(str_replace('/\([^)]+?\)$/', '', $token)); + $method = 'get' . ucfirst(preg_replace('/\([^)]+?\)$/', '', $token)); if (method_exists($object, $method)) { $replacement = (string) call_user_func_array(array($object, $method), $args); @@ -175,8 +175,8 @@ class MarkdownGenerator { * * @private * @memberOf MarkdownGenerator - * @param {Array} $result The result array to modify. - * @param {Array} $entries The entries to add to the `$result`. + * @param {array} $result The result array to modify. + * @param {array} $entries The entries to add to the `$result`. */ private function addEntries( &$result, $entries ) { foreach ($entries as $entry) { @@ -207,7 +207,7 @@ class MarkdownGenerator { 'desc' => $param[2], 'name' => $param[1], 'num' => $index + 1, - 'type' => $param[0] + 'type' => preg_replace('/(? $returns[1], 'type' => $returns[0])) + MarkdownGenerator::interpolate('(#{type}): #{desc}', array( + 'desc' => $returns[1], + 'type' => preg_replace('/(?entries[$entry] : $entry; $member = !$member ? $entry->getMembers(0) : $member; + $result = ($member ? $member . ($entry->isPlugin() ? 'prototype' : '') : '') . $entry->getCall(); $result = preg_replace('/\(\[|\[\]/', '', $result); $result = preg_replace('/[\t =|\'"{}.()\]]/', '', $result); @@ -251,8 +255,8 @@ class MarkdownGenerator { * * @private * @memberOf MarkdownGenerator - * @param {Number|Object} $entry The entry object. - * @returns {String} The url. + * @param {(number|object)} $entry The entry object. + * @returns {string} The url. */ private function getLineUrl( $entry ) { $entry = is_numeric($entry) ? $this->entries($entry) : $entry; @@ -264,8 +268,8 @@ class MarkdownGenerator { * * @private * @memberOf MarkdownGenerator - * @param {Number|Object} $entry The entry object. - * @returns {String} The separator. + * @param {(number|object)} $entry The entry object. + * @returns {string} The separator. */ private function getSeparator( $entry ) { $entry = is_numeric($entry) ? $this->entries($entry) : $entry; @@ -278,7 +282,7 @@ class MarkdownGenerator { * Generates Markdown from JSDoc entries. * * @memberOf MarkdownGenerator - * @returns {String} The rendered Markdown. + * @returns {string} The rendered Markdown. */ public function generate() { $api = array(); @@ -311,7 +315,7 @@ class MarkdownGenerator { } // append entry to api member - if (!$member || $entry->isCtor() || ($entry->getType() == 'Object' && + if (!$member || $entry->isCtor() || ($entry->getType() == 'object' && !preg_match('/[=:]\s*(?:null|undefined)\s*[,;]?$/', $entry->entry))) { // assign the real entry, replacing the temporary entry if it exist @@ -396,7 +400,7 @@ class MarkdownGenerator { foreach ($entry->{$kind} as $subentry) { $name = $subentry->getName(); // functions w/o ALL-CAPs names are last - $sortBy['a'][] = $subentry->getType() == 'Function' && !preg_match('/^[A-Z_]+$/', $name); + $sortBy['a'][] = $subentry->getType() == 'function' && !preg_match('/^[A-Z_]+$/', $name); // ALL-CAPs properties first $sortBy['b'][] = preg_match('/^[A-Z_]+$/', $name); // lowercase alphanumeric sort @@ -537,7 +541,7 @@ class MarkdownGenerator { $subentries = is_string($kind) ? $entry->{$kind} : array($kind); // add sub-entry name - if ($kind != 'static' && $entry->getType() != 'Object' && + if ($kind != 'static' && $entry->getType() != 'object' && count($subentries) && $subentries[0] != $kind) { if ($kind == 'plugin') { $result[] = $closeTag;