mirror of
https://github.com/whoisclebs/lodash.git
synced 2026-02-01 23:57:49 +00:00
Prefer array use for doc examples of params that accept arrays. [ci skip]
This commit is contained in:
44
lodash.js
44
lodash.js
@@ -6950,11 +6950,11 @@
|
||||
* @returns {Array} Returns `array`.
|
||||
* @example
|
||||
*
|
||||
* var array = [1, 2, 3, 1, 2, 3];
|
||||
* var array = ['a', 'b', 'c', 'a', 'b', 'c'];
|
||||
*
|
||||
* _.pull(array, 2, 3);
|
||||
* _.pull(array, 'a', 'c');
|
||||
* console.log(array);
|
||||
* // => [1, 1]
|
||||
* // => ['b', 'b']
|
||||
*/
|
||||
var pull = rest(pullAll);
|
||||
|
||||
@@ -6972,11 +6972,11 @@
|
||||
* @returns {Array} Returns `array`.
|
||||
* @example
|
||||
*
|
||||
* var array = [1, 2, 3, 1, 2, 3];
|
||||
* var array = ['a', 'b', 'c', 'a', 'b', 'c'];
|
||||
*
|
||||
* _.pullAll(array, [2, 3]);
|
||||
* _.pullAll(array, ['a', 'c']);
|
||||
* console.log(array);
|
||||
* // => [1, 1]
|
||||
* // => ['b', 'b']
|
||||
*/
|
||||
function pullAll(array, values) {
|
||||
return (array && array.length && values && values.length)
|
||||
@@ -7058,14 +7058,14 @@
|
||||
* @returns {Array} Returns the new array of removed elements.
|
||||
* @example
|
||||
*
|
||||
* var array = [5, 10, 15, 20];
|
||||
* var evens = _.pullAt(array, 1, 3);
|
||||
* var array = ['a', 'b', 'c', 'd'];
|
||||
* var pulled = _.pullAt(array, [1, 3]);
|
||||
*
|
||||
* console.log(array);
|
||||
* // => [5, 15]
|
||||
* // => ['a', 'c']
|
||||
*
|
||||
* console.log(evens);
|
||||
* // => [10, 20]
|
||||
* console.log(pulled);
|
||||
* // => ['b', 'd']
|
||||
*/
|
||||
var pullAt = rest(function(array, indexes) {
|
||||
indexes = baseFlatten(indexes, 1);
|
||||
@@ -8077,9 +8077,6 @@
|
||||
*
|
||||
* _(object).at(['a[0].b.c', 'a[1]']).value();
|
||||
* // => [3, 4]
|
||||
*
|
||||
* _(['a', 'b', 'c']).at(0, 2).value();
|
||||
* // => ['a', 'c']
|
||||
*/
|
||||
var wrapperAt = rest(function(paths) {
|
||||
paths = baseFlatten(paths, 1);
|
||||
@@ -9936,7 +9933,7 @@
|
||||
*
|
||||
* var func = _.overArgs(function(x, y) {
|
||||
* return [x, y];
|
||||
* }, square, doubled);
|
||||
* }, [square, doubled]);
|
||||
*
|
||||
* func(9, 3);
|
||||
* // => [81, 6]
|
||||
@@ -10053,7 +10050,7 @@
|
||||
*
|
||||
* var rearged = _.rearg(function(a, b, c) {
|
||||
* return [a, b, c];
|
||||
* }, 2, 0, 1);
|
||||
* }, [2, 0, 1]);
|
||||
*
|
||||
* rearged('b', 'c', 'a')
|
||||
* // => ['a', 'b', 'c']
|
||||
@@ -12037,9 +12034,6 @@
|
||||
*
|
||||
* _.at(object, ['a[0].b.c', 'a[1]']);
|
||||
* // => [3, 4]
|
||||
*
|
||||
* _.at(['a', 'b', 'c'], 0, 2);
|
||||
* // => ['a', 'c']
|
||||
*/
|
||||
var at = rest(function(object, paths) {
|
||||
return baseAt(object, baseFlatten(paths, 1));
|
||||
@@ -14587,7 +14581,7 @@
|
||||
* }
|
||||
* };
|
||||
*
|
||||
* _.bindAll(view, 'onClick');
|
||||
* _.bindAll(view, ['onClick']);
|
||||
* jQuery(element).on('click', view.onClick);
|
||||
* // => Logs 'clicked docs' when clicked.
|
||||
*/
|
||||
@@ -14718,7 +14712,7 @@
|
||||
* return n * n;
|
||||
* }
|
||||
*
|
||||
* var addSquare = _.flow(_.add, square);
|
||||
* var addSquare = _.flow([_.add, square]);
|
||||
* addSquare(1, 2);
|
||||
* // => 9
|
||||
*/
|
||||
@@ -14741,7 +14735,7 @@
|
||||
* return n * n;
|
||||
* }
|
||||
*
|
||||
* var addSquare = _.flowRight(square, _.add);
|
||||
* var addSquare = _.flowRight([square, _.add]);
|
||||
* addSquare(1, 2);
|
||||
* // => 9
|
||||
*/
|
||||
@@ -15076,7 +15070,7 @@
|
||||
* @returns {Function} Returns the new function.
|
||||
* @example
|
||||
*
|
||||
* var func = _.over(Math.max, Math.min);
|
||||
* var func = _.over([Math.max, Math.min]);
|
||||
*
|
||||
* func(1, 2, 3, 4);
|
||||
* // => [4, 1]
|
||||
@@ -15096,7 +15090,7 @@
|
||||
* @returns {Function} Returns the new function.
|
||||
* @example
|
||||
*
|
||||
* var func = _.overEvery(Boolean, isFinite);
|
||||
* var func = _.overEvery([Boolean, isFinite]);
|
||||
*
|
||||
* func('1');
|
||||
* // => true
|
||||
@@ -15122,7 +15116,7 @@
|
||||
* @returns {Function} Returns the new function.
|
||||
* @example
|
||||
*
|
||||
* var func = _.overSome(Boolean, isFinite);
|
||||
* var func = _.overSome([Boolean, isFinite]);
|
||||
*
|
||||
* func('1');
|
||||
* // => true
|
||||
|
||||
Reference in New Issue
Block a user