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

Cleanup resolve doc examples. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2016-01-11 16:10:21 -08:00
parent 9211bc6329
commit 359ef9715e
1 changed files with 71 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
lodash.js
View File

@@ -5480,28 +5480,26 @@
* @returns {Array} Returns the slice of `array`. * @returns {Array} Returns the slice of `array`.
* @example * @example
* *
* var resolve = _.partial(_.map, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'active': true }, * { 'user': 'barney', 'active': true },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': false },
* { 'user': 'pebbles', 'active': false } * { 'user': 'pebbles', 'active': false }
* ]; * ];
* *
* resolve( _.dropRightWhile(users, function(o) { return !o.active; }) ); * _.dropRightWhile(users, function(o) { return !o.active; });
* // => ['barney'] * // => objects for ['barney']
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.dropRightWhile(users, { 'user': 'pebbles', 'active': false }) ); * _.dropRightWhile(users, { 'user': 'pebbles', 'active': false });
* // => ['barney', 'fred'] * // => objects for ['barney', 'fred']
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.dropRightWhile(users, ['active', false]) ); * _.dropRightWhile(users, ['active', false]);
* // => ['barney'] * // => objects for ['barney']
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.dropRightWhile(users, 'active') ); * _.dropRightWhile(users, 'active');
* // => ['barney', 'fred', 'pebbles'] * // => objects for ['barney', 'fred', 'pebbles']
*/ */
function dropRightWhile(array, predicate) { function dropRightWhile(array, predicate) {
return (array && array.length) return (array && array.length)
@@ -5522,28 +5520,26 @@
* @returns {Array} Returns the slice of `array`. * @returns {Array} Returns the slice of `array`.
* @example * @example
* *
* var resolve = _.partial(_.map, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'active': false }, * { 'user': 'barney', 'active': false },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': false },
* { 'user': 'pebbles', 'active': true } * { 'user': 'pebbles', 'active': true }
* ]; * ];
* *
* resolve( _.dropWhile(users, function(o) { return !o.active; }) ); * _.dropWhile(users, function(o) { return !o.active; });
* // => ['pebbles'] * // => objects for ['pebbles']
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.dropWhile(users, { 'user': 'barney', 'active': false }) ); * _.dropWhile(users, { 'user': 'barney', 'active': false });
* // => ['fred', 'pebbles'] * // => objects for ['fred', 'pebbles']
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.dropWhile(users, ['active', false]) ); * _.dropWhile(users, ['active', false]);
* // => ['pebbles'] * // => objects for ['pebbles']
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.dropWhile(users, 'active') ); * _.dropWhile(users, 'active');
* // => ['barney', 'fred', 'pebbles'] * // => objects for ['barney', 'fred', 'pebbles']
*/ */
function dropWhile(array, predicate) { function dropWhile(array, predicate) {
return (array && array.length) return (array && array.length)
@@ -6483,27 +6479,25 @@
* @returns {Array} Returns the slice of `array`. * @returns {Array} Returns the slice of `array`.
* @example * @example
* *
* var resolve = _.partial(_.map, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'active': true }, * { 'user': 'barney', 'active': true },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': false },
* { 'user': 'pebbles', 'active': false } * { 'user': 'pebbles', 'active': false }
* ]; * ];
* *
* resolve( _.takeRightWhile(users, function(o) { return !o.active; }) ); * _.takeRightWhile(users, function(o) { return !o.active; });
* // => ['fred', 'pebbles'] * // => objects for ['fred', 'pebbles']
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.takeRightWhile(users, { 'user': 'pebbles', 'active': false }) ); * _.takeRightWhile(users, { 'user': 'pebbles', 'active': false });
* // => ['pebbles'] * // => objects for ['pebbles']
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.takeRightWhile(users, ['active', false]) ); * _.takeRightWhile(users, ['active', false]);
* // => ['fred', 'pebbles'] * // => objects for ['fred', 'pebbles']
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.takeRightWhile(users, 'active') ); * _.takeRightWhile(users, 'active');
* // => [] * // => []
*/ */
function takeRightWhile(array, predicate) { function takeRightWhile(array, predicate) {
@@ -6525,27 +6519,25 @@
* @returns {Array} Returns the slice of `array`. * @returns {Array} Returns the slice of `array`.
* @example * @example
* *
* var resolve = _.partial(_.map, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'active': false }, * { 'user': 'barney', 'active': false },
* { 'user': 'fred', 'active': false}, * { 'user': 'fred', 'active': false},
* { 'user': 'pebbles', 'active': true } * { 'user': 'pebbles', 'active': true }
* ]; * ];
* *
* resolve( _.takeWhile(users, function(o) { return !o.active; }) ); * _.takeWhile(users, function(o) { return !o.active; });
* // => ['barney', 'fred'] * // => objects for ['barney', 'fred']
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.takeWhile(users, { 'user': 'barney', 'active': false }) ); * _.takeWhile(users, { 'user': 'barney', 'active': false });
* // => ['barney'] * // => objects for ['barney']
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.takeWhile(users, ['active', false]) ); * _.takeWhile(users, ['active', false]);
* // => ['barney', 'fred'] * // => objects for ['barney', 'fred']
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.takeWhile(users, 'active') ); * _.takeWhile(users, 'active');
* // => [] * // => []
*/ */
function takeWhile(array, predicate) { function takeWhile(array, predicate) {
@@ -7362,27 +7354,25 @@
* @returns {Array} Returns the new filtered array. * @returns {Array} Returns the new filtered array.
* @example * @example
* *
* var resolve = _.partial(_.map, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'age': 36, 'active': true }, * { 'user': 'barney', 'age': 36, 'active': true },
* { 'user': 'fred', 'age': 40, 'active': false } * { 'user': 'fred', 'age': 40, 'active': false }
* ]; * ];
* *
* resolve( _.filter(users, function(o) { return !o.active; }) ); * _.filter(users, function(o) { return !o.active; });
* // => ['fred'] * // => objects for ['fred']
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.filter(users, { 'age': 36, 'active': true }) ); * _.filter(users, { 'age': 36, 'active': true });
* // => ['barney'] * // => objects for ['barney']
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.filter(users, ['active', false]) ); * _.filter(users, ['active', false]);
* // => ['fred'] * // => objects for ['fred']
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.filter(users, 'active') ); * _.filter(users, 'active');
* // => ['barney'] * // => objects for ['barney']
*/ */
function filter(collection, predicate) { function filter(collection, predicate) {
var func = isArray(collection) ? arrayFilter : baseFilter; var func = isArray(collection) ? arrayFilter : baseFilter;
@@ -7402,28 +7392,26 @@
* @returns {*} Returns the matched element, else `undefined`. * @returns {*} Returns the matched element, else `undefined`.
* @example * @example
* *
* var resolve = _.partial(_.result, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'age': 36, 'active': true }, * { 'user': 'barney', 'age': 36, 'active': true },
* { 'user': 'fred', 'age': 40, 'active': false }, * { 'user': 'fred', 'age': 40, 'active': false },
* { 'user': 'pebbles', 'age': 1, 'active': true } * { 'user': 'pebbles', 'age': 1, 'active': true }
* ]; * ];
* *
* resolve( _.find(users, function(o) { return o.age < 40; }) ); * _.find(users, function(o) { return o.age < 40; });
* // => 'barney' * // => object for 'barney'
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.find(users, { 'age': 1, 'active': true }) ); * _.find(users, { 'age': 1, 'active': true });
* // => 'pebbles' * // => object for 'pebbles'
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.find(users, ['active', false]) ); * _.find(users, ['active', false]);
* // => 'fred' * // => object for 'fred'
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.find(users, 'active') ); * _.find(users, 'active');
* // => 'barney' * // => object for 'barney'
*/ */
function find(collection, predicate) { function find(collection, predicate) {
predicate = getIteratee(predicate, 3); predicate = getIteratee(predicate, 3);
@@ -7716,8 +7704,6 @@
* @returns {Array} Returns the new sorted array. * @returns {Array} Returns the new sorted array.
* @example * @example
* *
* var resolve = _.partial(_.map, _, _.values);
*
* var users = [ * var users = [
* { 'user': 'fred', 'age': 48 }, * { 'user': 'fred', 'age': 48 },
* { 'user': 'barney', 'age': 34 }, * { 'user': 'barney', 'age': 34 },
@@ -7726,8 +7712,8 @@
* ]; * ];
* *
* // sort by `user` in ascending order and by `age` in descending order * // sort by `user` in ascending order and by `age` in descending order
* resolve( _.orderBy(users, ['user', 'age'], ['asc', 'desc']) ); * _.orderBy(users, ['user', 'age'], ['asc', 'desc']);
* // => [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]] * // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
*/ */
function orderBy(collection, iteratees, orders, guard) { function orderBy(collection, iteratees, orders, guard) {
if (collection == null) { if (collection == null) {
@@ -7757,30 +7743,26 @@
* @returns {Array} Returns the array of grouped elements. * @returns {Array} Returns the array of grouped elements.
* @example * @example
* *
* var resolve = function(result) {
* return _.map(result, function(array) { return _.map(array, 'user'); });
* };
*
* var users = [ * var users = [
* { 'user': 'barney', 'age': 36, 'active': false }, * { 'user': 'barney', 'age': 36, 'active': false },
* { 'user': 'fred', 'age': 40, 'active': true }, * { 'user': 'fred', 'age': 40, 'active': true },
* { 'user': 'pebbles', 'age': 1, 'active': false } * { 'user': 'pebbles', 'age': 1, 'active': false }
* ]; * ];
* *
* resolve( _.partition(users, function(o) { return o.active; }) ); * _.partition(users, function(o) { return o.active; });
* // => [['fred'], ['barney', 'pebbles']] * // => objects for [['fred'], ['barney', 'pebbles']]
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.partition(users, { 'age': 1, 'active': false }) ); * _.partition(users, { 'age': 1, 'active': false });
* // => [['pebbles'], ['barney', 'fred']] * // => objects for [['pebbles'], ['barney', 'fred']]
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.partition(users, ['active', false]) ); * _.partition(users, ['active', false]);
* // => [['barney', 'pebbles'], ['fred']] * // => objects for [['barney', 'pebbles'], ['fred']]
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.partition(users, 'active') ); * _.partition(users, 'active');
* // => [['fred'], ['barney', 'pebbles']] * // => objects for [['fred'], ['barney', 'pebbles']]
*/ */
var partition = createAggregator(function(result, value, key) { var partition = createAggregator(function(result, value, key) {
result[key ? 0 : 1].push(value); result[key ? 0 : 1].push(value);
@@ -7867,27 +7849,25 @@
* @returns {Array} Returns the new filtered array. * @returns {Array} Returns the new filtered array.
* @example * @example
* *
* var resolve = _.partial(_.map, _, 'user');
*
* var users = [ * var users = [
* { 'user': 'barney', 'age': 36, 'active': false }, * { 'user': 'barney', 'age': 36, 'active': false },
* { 'user': 'fred', 'age': 40, 'active': true } * { 'user': 'fred', 'age': 40, 'active': true }
* ]; * ];
* *
* resolve( _.reject(users, function(o) { return !o.active; }) ); * _.reject(users, function(o) { return !o.active; });
* // => ['fred'] * // => objects for ['fred']
* *
* // using the `_.matches` iteratee shorthand * // using the `_.matches` iteratee shorthand
* resolve( _.reject(users, { 'age': 40, 'active': true }) ); * _.reject(users, { 'age': 40, 'active': true });
* // => ['barney'] * // => objects for ['barney']
* *
* // using the `_.matchesProperty` iteratee shorthand * // using the `_.matchesProperty` iteratee shorthand
* resolve( _.reject(users, ['active', false]) ); * _.reject(users, ['active', false]);
* // => ['fred'] * // => objects for ['fred']
* *
* // using the `_.property` iteratee shorthand * // using the `_.property` iteratee shorthand
* resolve( _.reject(users, 'active') ); * _.reject(users, 'active');
* // => ['barney'] * // => objects for ['barney']
*/ */
function reject(collection, predicate) { function reject(collection, predicate) {
var func = isArray(collection) ? arrayFilter : baseFilter; var func = isArray(collection) ? arrayFilter : baseFilter;
@@ -8055,8 +8035,6 @@
* @returns {Array} Returns the new sorted array. * @returns {Array} Returns the new sorted array.
* @example * @example
* *
* var resolve = _.partial(_.map, _, _.values);
*
* var users = [ * var users = [
* { 'user': 'fred', 'age': 48 }, * { 'user': 'fred', 'age': 48 },
* { 'user': 'barney', 'age': 36 }, * { 'user': 'barney', 'age': 36 },
@@ -8064,16 +8042,16 @@
* { 'user': 'barney', 'age': 34 } * { 'user': 'barney', 'age': 34 }
* ]; * ];
* *
* resolve( _.sortBy(users, function(o) { return o.user; }) ); * _.sortBy(users, function(o) { return o.user; });
* // => // => [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]] * // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
* *
* resolve( _.sortBy(users, ['user', 'age']) ); * _.sortBy(users, ['user', 'age']);
* // => [['barney', 34], ['barney', 36], ['fred', 42], ['fred', 48]] * // => objects for [['barney', 34], ['barney', 36], ['fred', 42], ['fred', 48]]
* *
* resolve( _.sortBy(users, 'user', function(o) { * _.sortBy(users, 'user', function(o) {
* return Math.floor(o.age / 10); * return Math.floor(o.age / 10);
* }) ); * });
* // => [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]] * // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 42]]
*/ */
var sortBy = rest(function(collection, iteratees) { var sortBy = rest(function(collection, iteratees) {
if (collection == null) { if (collection == null) {