Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-11 03:17:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Replace passed with provided in docs and test descriptions.

Browse Source 
Former-commit-id: b47302b804a7e4f89a0dbacfb85d24d80dae81a9
This commit is contained in:
John-David Dalton
2013-08-03 13:32:32 -07:00
parent 56346f2a52
commit 4f6f6cca0f
2 changed files with 47 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

64
lodash.js
View File

@@ -582,7 +582,7 @@
* `sortedIndex`, `runInContext`, `template`, `unescape`, `uniqueId`, and `value` * `sortedIndex`, `runInContext`, `template`, `unescape`, `uniqueId`, and `value`
* *
* The wrapper functions `first` and `last` return wrapped values when `n` is * The wrapper functions `first` and `last` return wrapped values when `n` is
* passed, otherwise they return unwrapped values. * provided, otherwise they return unwrapped values.
* *
* @name _ * @name _
* @constructor * @constructor
@@ -1417,14 +1417,14 @@
/** /**
* Creates a function that, when called, invokes `func` with the `this` binding * Creates a function that, when called, invokes `func` with the `this` binding
* of `thisArg` and prepends any `partialArgs` to the arguments passed to the * of `thisArg` and prepends any `partialArgs` to the arguments provided to the
* bound function. * bound function.
* *
* @private * @private
* @param {Function|String} func The function to bind or the method name. * @param {Function|String} func The function to bind or the method name.
* @param {Mixed} thisArg The `this` binding of `func`. * @param {Mixed} thisArg The `this` binding of `func`.
* @param {Array} partialArgs An array of arguments to be prepended to those passed to the new function. * @param {Array} partialArgs An array of arguments to be prepended to those provided to the new function.
* @param {Array} partialRightArgs An array of arguments to be appended to those passed to the new function. * @param {Array} partialRightArgs An array of arguments to be appended to those provided to the new function.
* @param {Boolean} [isPartial=false] A flag to indicate performing only partial application. * @param {Boolean} [isPartial=false] A flag to indicate performing only partial application.
* @param {Boolean} [isAlt=false] A flag to indicate `_.bindKey` or `_.partialRight` behavior. * @param {Boolean} [isAlt=false] A flag to indicate `_.bindKey` or `_.partialRight` behavior.
* @returns {Function} Returns the new bound function. * @returns {Function} Returns the new bound function.
@@ -1980,7 +1980,7 @@
/** /**
* This method is like `_.findIndex`, except that it returns the key of the * This method is like `_.findIndex`, except that it returns the key of the
* element that passes the callback check, instead of the element itself. * first element that passes the callback check, instead of the element itself.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -3044,7 +3044,7 @@
* per iteration. If a property name or object is provided, it will be used * per iteration. If a property name or object is provided, it will be used
* to create a "_.pluck" or "_.where" style callback, respectively. * to create a "_.pluck" or "_.where" style callback, respectively.
* @param {Mixed} [thisArg] The `this` binding of `callback`. * @param {Mixed} [thisArg] The `this` binding of `callback`.
* @returns {Boolean} Returns `true` if all elements pass the callback check, * @returns {Boolean} Returns `true` if all elements passed the callback check,
* else `false`. * else `false`.
* @example * @example
* *
@@ -3407,7 +3407,7 @@
/** /**
* Invokes the method named by `methodName` on each element in the `collection`, * Invokes the method named by `methodName` on each element in the `collection`,
* returning an array of the results of each invoked method. Additional arguments * returning an array of the results of each invoked method. Additional arguments
* will be passed to each invoked method. If `methodName` is a function, it will * 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`. * be invoked for, and `this` bound to, each element in the `collection`.
* *
* @static * @static
@@ -3660,7 +3660,7 @@
* Reduces a `collection` to a value which is the accumulated result of running * Reduces a `collection` to a value which is the accumulated result of running
* each element in the `collection` through the `callback`, where each successive * each element in the `collection` through the `callback`, where each successive
* `callback` execution consumes the return value of the previous execution. * `callback` execution consumes the return value of the previous execution.
* If `accumulator` is not passed, the first element of the `collection` will be * 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` * used as the initial `accumulator` value. The `callback` is bound to `thisArg`
* and invoked with four arguments; (accumulator, value, index|key, collection). * and invoked with four arguments; (accumulator, value, index|key, collection).
* *
@@ -3919,7 +3919,7 @@
* per iteration. If a property name or object is provided, it will be used * per iteration. If a property name or object is provided, it will be used
* to create a "_.pluck" or "_.where" style callback, respectively. * to create a "_.pluck" or "_.where" style callback, respectively.
* @param {Mixed} [thisArg] The `this` binding of `callback`. * @param {Mixed} [thisArg] The `this` binding of `callback`.
* @returns {Boolean} Returns `true` if any element passes the callback check, * @returns {Boolean} Returns `true` if any element passed the callback check,
* else `false`. * else `false`.
* @example * @example
* *
@@ -4098,8 +4098,8 @@
} }
/** /**
* Creates an array excluding all values of the passed-in arrays using * Creates an array excluding all values of the provided arrays using strict
* strict equality for comparisons, i.e. `===`. * equality for comparisons, i.e. `===`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -4143,7 +4143,7 @@
} }
/** /**
* This method is like `_.find`, except that it returns the index of the * 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. * element that passes the callback check, instead of the element itself.
* *
* @static * @static
@@ -4451,7 +4451,7 @@
} }
/** /**
* Creates an array of unique values present in all passed-in arrays using * Creates an array of unique values present in all provided arrays using
* strict equality for comparisons, i.e. `===`. * strict equality for comparisons, i.e. `===`.
* *
* @static * @static
@@ -4621,7 +4621,7 @@
} }
/** /**
* Removes all passed values from the given array using strict equality for * Removes all provided values from the given array using strict equality for
* comparisons, i.e. `===`. * comparisons, i.e. `===`.
* *
* @static * @static
@@ -4846,8 +4846,8 @@
} }
/** /**
* Creates an array of unique values, in order, of the passed-in arrays * Creates an array of unique values, in order, of the provided arrays using
* using strict equality for comparisons, i.e. `===`. * strict equality for comparisons, i.e. `===`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -4921,7 +4921,7 @@
} }
/** /**
* Creates an array excluding all passed values using strict equality for * Creates an array excluding all provided values using strict equality for
* comparisons, i.e. `===`. * comparisons, i.e. `===`.
* *
* @static * @static
@@ -5033,7 +5033,7 @@
/** /**
* Creates a function that, when called, invokes `func` with the `this` * Creates a function that, when called, invokes `func` with the `this`
* binding of `thisArg` and prepends any additional `bind` arguments to those * binding of `thisArg` and prepends any additional `bind` arguments to those
* passed to the bound function. * provided to the bound function.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -5094,7 +5094,7 @@
/** /**
* Creates a function that, when called, invokes the method at `object[key]` * Creates a function that, when called, invokes the method at `object[key]`
* and prepends any additional `bindKey` arguments to those passed to the bound * and prepends any additional `bindKey` arguments to those provided to the bound
* function. This method differs from `_.bind` by allowing bound functions to * function. This method differs from `_.bind` by allowing bound functions to
* reference methods that will be redefined or don't yet exist. * reference methods that will be redefined or don't yet exist.
* See http://michaux.ca/articles/lazy-function-definition-pattern. * See http://michaux.ca/articles/lazy-function-definition-pattern.
@@ -5131,7 +5131,7 @@
} }
/** /**
* Creates a function that is the composition of the passed functions, * Creates a function that is the composition of the provided functions,
* where each function consumes the return value of the function that follows. * 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()))`. * 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. * Each function is executed with the `this` binding of the composed function.
@@ -5364,7 +5364,7 @@
/** /**
* Defers executing the `func` function until the current call stack has cleared. * Defers executing the `func` function until the current call stack has cleared.
* Additional arguments will be passed to `func` when it is invoked. * Additional arguments will be provided to `func` when it is invoked.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -5388,7 +5388,7 @@
/** /**
* Executes the `func` function after `wait` milliseconds. Additional arguments * Executes the `func` function after `wait` milliseconds. Additional arguments
* will be passed to `func` when it is invoked. * will be provided to `func` when it is invoked.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -5410,11 +5410,11 @@
/** /**
* Creates a function that memoizes the result of `func`. If `resolver` is * Creates a function that memoizes the result of `func`. If `resolver` is
* passed, it will be used to determine the cache key for storing the result * provided, it will be used to determine the cache key for storing the result
* based on the arguments passed to the memoized function. By default, the first * based on the arguments provided to the memoized function. By default, the
* argument passed to the memoized function is used as the cache key. The `func` * first argument provided to the memoized function is used as the cache key.
* is executed with the `this` binding of the memoized function. The result * The `func` is executed with the `this` binding of the memoized function.
* cache is exposed as the `cache` property on the memoized function. * The result cache is exposed as the `cache` property on the memoized function.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -5477,7 +5477,7 @@
/** /**
* Creates a function that, when called, invokes `func` with any additional * Creates a function that, when called, invokes `func` with any additional
* `partial` arguments prepended to those passed to the new function. This * `partial` arguments prepended to those provided to the new function. This
* method is similar to `_.bind`, except it does **not** alter the `this` binding. * method is similar to `_.bind`, except it does **not** alter the `this` binding.
* *
* @static * @static
@@ -5499,7 +5499,7 @@
/** /**
* This method is like `_.partial`, except that `partial` arguments are * This method is like `_.partial`, except that `partial` arguments are
* appended to those passed to the new function. * appended to those provided to the new function.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -5581,8 +5581,8 @@
/** /**
* Creates a function that passes `value` to the `wrapper` function as its * Creates a function that passes `value` to the `wrapper` function as its
* first argument. Additional arguments passed to the function are appended * first argument. Additional arguments provided to the function are appended
* to those passed to the `wrapper` function. The `wrapper` is executed with * to those provided to the `wrapper` function. The `wrapper` is executed with
* the `this` binding of the created function. * the `this` binding of the created function.
* *
* @static * @static
@@ -5629,7 +5629,7 @@
} }
/** /**
* This method returns the first argument passed to it. * This method returns the first argument provided to it.
* *
* @static * @static
* @memberOf _ * @memberOf _

30
test/test.js
View File

@@ -218,7 +218,7 @@
ok(_() instanceof _); ok(_() instanceof _);
}); });
test('should return passed `lodash` instances', function() { test('should return provided `lodash` instances', function() {
var wrapped = _(false); var wrapped = _(false);
equal(_(wrapped), wrapped); equal(_(wrapped), wrapped);
}); });
@@ -250,7 +250,7 @@
deepEqual(actual, ['a', 'c', undefined]); deepEqual(actual, ['a', 'c', undefined]);
}); });
test('should return an empty array when no keys are passed', function() { test('should return an empty array when no keys are provided', function() {
deepEqual(_.at(['a', 'b', 'c']), []); deepEqual(_.at(['a', 'b', 'c']), []);
}); });
@@ -598,7 +598,7 @@
QUnit.module('lodash.countBy'); QUnit.module('lodash.countBy');
(function() { (function() {
test('should use `_.identity` when no `callback` is passed', function() { test('should use `_.identity` when no `callback` is provided', function() {
var actual = _.countBy([4, 6, 6]); var actual = _.countBy([4, 6, 6]);
deepEqual(actual, { '4': 1, '6': 2 }); deepEqual(actual, { '4': 1, '6': 2 });
}); });
@@ -856,7 +856,7 @@
equal(_.escape("'"), "'"); equal(_.escape("'"), "'");
}); });
test('should return an empty string when passed `null` or `undefined`', function() { test('should return an empty string when provided `null` or `undefined`', function() {
equal(_.escape(null), ''); equal(_.escape(null), '');
equal(_.escape(undefined), ''); equal(_.escape(undefined), '');
}); });
@@ -1048,7 +1048,7 @@
ok(actual instanceof _); ok(actual instanceof _);
}); });
test('should not chain when no arguments are passed', function() { test('should not chain when arguments are not provided', function() {
var actual = _(array).first(); var actual = _(array).first();
strictEqual(actual, 1); strictEqual(actual, 1);
}); });
@@ -1446,7 +1446,7 @@
QUnit.module('lodash.groupBy'); QUnit.module('lodash.groupBy');
(function() { (function() {
test('should use `_.identity` when no `callback` is passed', function() { test('should use `_.identity` when no `callback` is provided', function() {
var actual = _.groupBy([4, 6, 6]); var actual = _.groupBy([4, 6, 6]);
deepEqual(actual, { '4': [4], '6': [6, 6] }); deepEqual(actual, { '4': [4], '6': [6, 6] });
}); });
@@ -1493,7 +1493,7 @@
QUnit.module('lodash.indexBy'); QUnit.module('lodash.indexBy');
(function() { (function() {
test('should use `_.identity` when no `callback` is passed', function() { test('should use `_.identity` when no `callback` is provided', function() {
var actual = _.indexBy([4, 6, 6]); var actual = _.indexBy([4, 6, 6]);
deepEqual(actual, { '4': 4, '6': 6 }); deepEqual(actual, { '4': 4, '6': 6 });
}); });
@@ -2141,7 +2141,7 @@
ok(actual instanceof _); ok(actual instanceof _);
}); });
test('should not chain when no arguments are passed', function() { test('should not chain when arguments are not provided', function() {
var actual = _(array).last(); var actual = _(array).last();
equal(actual, 3); equal(actual, 3);
}); });
@@ -2244,7 +2244,7 @@
QUnit.module('lodash.max and lodash.min chaining'); QUnit.module('lodash.max and lodash.min chaining');
_.forEach(['max', 'min'], function(methodName) { _.forEach(['max', 'min'], function(methodName) {
test('`_.' + methodName + '` should resolve the correct value when passed an array containing only one value', function() { test('`_.' + methodName + '` should resolve the correct value when provided an array containing only one value', function() {
var actual = _([40])[methodName]().value(); var actual = _([40])[methodName]().value();
strictEqual(actual, 40); strictEqual(actual, 40);
}); });
@@ -2719,7 +2719,7 @@
QUnit.module('lodash.random'); QUnit.module('lodash.random');
(function() { (function() {
test('should return `0` or `1` when no arguments are passed', function() { test('should return `0` or `1` when arguments are not provided', function() {
var actual = _.random(); var actual = _.random();
ok(actual === 0 || actual === 1); ok(actual === 0 || actual === 1);
}); });
@@ -2878,7 +2878,7 @@
QUnit.module('lodash.result'); QUnit.module('lodash.result');
(function() { (function() {
test('should return `undefined` when passed a falsey `object` argument', function() { test('should return `undefined` when provided a falsey `object` argument', function() {
strictEqual(_.result(), undefined); strictEqual(_.result(), undefined);
}); });
}()); }());
@@ -3067,7 +3067,7 @@
deepEqual(actual, collection); deepEqual(actual, collection);
}); });
test('should use `_.identity` when no `callback` is passed', function() { test('should use `_.identity` when no `callback` is provided', function() {
var actual = _.sortBy([3, 2, 1]); var actual = _.sortBy([3, 2, 1]);
deepEqual(actual, [1, 2, 3]); deepEqual(actual, [1, 2, 3]);
}); });
@@ -3593,7 +3593,7 @@
equal(_.unescape(_.escape(unescaped)), unescaped); equal(_.unescape(_.escape(unescaped)), unescaped);
}); });
test('should return an empty string when passed `null` or `undefined`', function() { test('should return an empty string when provided `null` or `undefined`', function() {
equal(_.unescape(null), ''); equal(_.unescape(null), '');
equal(_.unescape(undefined), ''); equal(_.unescape(undefined), '');
}); });
@@ -3604,7 +3604,7 @@
QUnit.module('lodash.union'); QUnit.module('lodash.union');
(function() { (function() {
test('should produce correct results when passed a falsey `array` argument', function() { test('should produce correct results when provided a falsey `array` argument', function() {
var expected = [1, 2, 3], var expected = [1, 2, 3],
actual = _.union(null, expected); actual = _.union(null, expected);
@@ -3722,7 +3722,7 @@
deepEqual(_.where(collection, { 'a': 1 }), [{ 'a': 1 }, { 'a': 1, 'b': 2 }]); deepEqual(_.where(collection, { 'a': 1 }), [{ 'a': 1 }, { 'a': 1, 'b': 2 }]);
}); });
test('should return an empty array when passed an empty `properties` object', function() { test('should return an empty array when provided an empty `properties` object', function() {
deepEqual(_.where(array, {}), []); deepEqual(_.where(array, {}), []);
}); });