Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-01-31 07:17:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix some misspellings in the docs.

Browse Source 
Former-commit-id: 38ec1d19f1e5ea1fbb05306e5b5cfc9fac550562
This commit is contained in:
andrew morton
2013-03-03 13:08:01 -08:00
parent 510c41440a
commit fefdb9fc8d
2 changed files with 42 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/README.md
View File

@@ -254,7 +254,7 @@ Gets the first element of the `array`. If a number `n` is passed, the first `n`
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*head, take*
@@ -374,7 +374,7 @@ Gets all but the last element of `array`. If a number `n` is passed, the last `n
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -455,7 +455,7 @@ Gets the last element of the `array`. If a number `n` is passed, the last `n` el
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -567,7 +567,7 @@ Creates an array of numbers *(positive and/or negative)* progressing from `start
#### 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 descrement by.
3. `[step=1]` *(Number)*: The value to increment or decrement by.
#### Returns
*(Array)*: Returns a new range array.
@@ -604,7 +604,7 @@ The opposite of `_.initial`, this method gets all but the first value of `array`
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*drop, tail*
@@ -664,7 +664,7 @@ Uses a binary search to determine the smallest index at which the `value` should
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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 iterate over.
@@ -737,7 +737,7 @@ Creates a duplicate-value-free version of the `array` using strict equality for
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*unique*
@@ -1019,7 +1019,7 @@ Creates an object composed of keys returned from running each element of the `co
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -1055,7 +1055,7 @@ Checks if the `callback` returns a truthy value for **all** elements of a `colle
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*all*
@@ -1101,7 +1101,7 @@ Examines each element in a `collection`, returning an array of all elements the
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*select*
@@ -1147,7 +1147,7 @@ Examines each element in a `collection`, returning the first that the `callback`
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*detect*
@@ -1227,7 +1227,7 @@ Creates an object composed of keys returned from running each element of the `co
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`
If an object is passed 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.
@@ -1293,7 +1293,7 @@ Creates an array of values by running each element in the `collection` through t
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*collect*
@@ -1338,7 +1338,7 @@ Retrieves the maximum value of an `array`. If `callback` is passed, it will be e
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -1380,7 +1380,7 @@ Retrieves the minimum value of an `array`. If `callback` is passed, it will be e
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -1521,7 +1521,7 @@ The opposite of `_.filter`, this method returns the elements of a `collection` t
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -1618,7 +1618,7 @@ Checks if the `callback` returns a truthy value for **any** element of a `collec
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the properties of the given object, else `false`.
#### Aliases
*any*
@@ -1664,7 +1664,7 @@ Creates an array of elements, sorted in ascending order by the results of runnin
If a property name is passed for `callback`, the created "_.pluck" style callback will return the property value of the given element.
If an object is passed for `callback`, the created "_.where" style callback will return `true` for elements that have the propeties of the given object, else `false`.
If an object is passed 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.
@@ -2171,7 +2171,7 @@ hello();
### <a id="_assignobject--source1-source2--callback-thisarg"></a>`_.assign(object [, source1, source2, ..., callback, thisArg])`
<a href="#_assignobject--source1-source2--callback-thisarg">#</a> [&#x24C8;](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1109 "View in source") [&#x24C9;][1]
Assigns own enumerable properties of source object(s) to the destination object. Subsequent sources will overwrite propery assignments of previous sources. If a `callback` function is passed, it will be executed to produce the assigned values. The `callback` is bound to `thisArg` and invoked with two arguments; *(objectValue, sourceValue)*.
Assigns own enumerable properties of source object(s) to the destination object. Subsequent sources will overwrite property assignments of previous sources. If a `callback` function is passed, it will be executed to produce the assigned values. The `callback` is bound to `thisArg` and invoked with two arguments; *(objectValue, sourceValue)*.
#### Aliases
*extend*
@@ -2633,7 +2633,7 @@ Performs a deep comparison between two values to determine if they are equivalen
4. `[thisArg]` *(Mixed)*: The `this` binding of `callback`.
#### Returns
*(Boolean)*: Returns `true`, if the values are equvalent, else `false`.
*(Boolean)*: Returns `true`, if the values are equivalent, else `false`.
#### Example
```js
@@ -2978,7 +2978,7 @@ _.keys({ 'one': 1, 'two': 2, 'three': 3 });
### <a id="_mergeobject--source1-source2--callback-thisarg"></a>`_.merge(object [, source1, source2, ..., callback, thisArg])`
<a href="#_mergeobject--source1-source2--callback-thisarg">#</a> [&#x24C8;](https://github.com/bestiejs/lodash/blob/master/lodash.js#L1961 "View in source") [&#x24C9;][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 propery assignments of previous sources. If a `callback` function is passed, it will be executed to produce the merged values of the destination and source properties. If `callback` returns `undefined`, merging will be handled by the method instead. The `callback` is bound to `thisArg` and invoked with two arguments; *(objectValue, sourceValue)*.
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` function is passed, it will be executed to produce the merged values of the destination and source properties. If `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.

42
lodash.js
View File

@@ -1078,7 +1078,7 @@
/**
* Assigns own enumerable properties of source object(s) to the destination
* object. Subsequent sources will overwrite propery assignments of previous
* object. Subsequent sources will overwrite property assignments of previous
* sources. If a `callback` function is passed, it will be executed to produce
* the assigned values. The `callback` is bound to `thisArg` and invoked with
* two arguments; (objectValue, sourceValue).
@@ -1487,7 +1487,7 @@
* @param {Mixed} [thisArg] The `this` binding of `callback`.
* @param- {Object} [stackA=[]] Internally used track traversed `a` objects.
* @param- {Object} [stackB=[]] Internally used track traversed `b` objects.
* @returns {Boolean} Returns `true`, if the values are equvalent, else `false`.
* @returns {Boolean} Returns `true`, if the values are equivalent, else `false`.
* @example
*
* var moe = { 'name': 'moe', 'age': 40 };
@@ -1905,7 +1905,7 @@
/**
* Recursively merges own enumerable properties of the source object(s), that
* don't resolve to `undefined`, into the destination object. Subsequent sources
* will overwrite propery assignments of previous sources. If a `callback` function
* will overwrite property assignments of previous sources. If a `callback` function
* is passed, it will be executed to produce the merged values of the destination
* and source properties. If `callback` returns `undefined`, merging will be
* handled by the method instead. The `callback` is bound to `thisArg` and
@@ -2303,7 +2303,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2346,7 +2346,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2408,7 +2408,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2472,7 +2472,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2567,7 +2567,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`
*
* @static
@@ -2646,7 +2646,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2704,7 +2704,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2773,7 +2773,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -2956,7 +2956,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3056,7 +3056,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3120,7 +3120,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3286,7 +3286,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3442,7 +3442,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3568,7 +3568,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3709,7 +3709,7 @@
* @category Arrays
* @param {Number} [start=0] The start of the range.
* @param {Number} end The end of the range.
* @param {Number} [step=1] The value to increment or descrement by.
* @param {Number} [step=1] The value to increment or decrement by.
* @returns {Array} Returns a new range array.
* @example
*
@@ -3761,7 +3761,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3834,7 +3834,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static
@@ -3918,7 +3918,7 @@
* callback will return the property value of the given element.
*
* If an object is passed for `callback`, the created "_.where" style callback
* will return `true` for elements that have the propeties of the given object,
* will return `true` for elements that have the properties of the given object,
* else `false`.
*
* @static