Use destructuring in code samples.

This commit is contained in:
John-David Dalton
2017-01-11 13:36:52 -08:00
parent d80077ed94
commit f5e7671fbc
18 changed files with 37 additions and 37 deletions

View File

@@ -13,12 +13,12 @@ import baseWhile from './.internal/baseWhile.js';
* @example * @example
* *
* const users = [ * const users = [
* { 'user': 'barney', 'active': true }, * { 'user': 'barney', 'active': false },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': true },
* { 'user': 'pebbles', 'active': false } * { 'user': 'pebbles', 'active': true }
* ]; * ];
* *
* dropRightWhile(users, o => !o.active); * dropRightWhile(users, ({ active }) => active);
* // => objects for ['barney'] * // => objects for ['barney']
*/ */
function dropRightWhile(array, predicate) { function dropRightWhile(array, predicate) {

View File

@@ -13,12 +13,12 @@ import baseWhile from './.internal/baseWhile.js';
* @example * @example
* *
* const users = [ * const users = [
* { 'user': 'barney', 'active': false }, * { 'user': 'barney', 'active': true },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': true },
* { 'user': 'pebbles', 'active': true } * { 'user': 'pebbles', 'active': false }
* ]; * ];
* *
* dropWhile(users, o => !o.active); * dropWhile(users, ({ active }) => active);
* // => objects for ['pebbles'] * // => objects for ['pebbles']
*/ */
function dropWhile(array, predicate) { function dropWhile(array, predicate) {

View File

@@ -17,12 +17,12 @@ import baseFilter from './.internal/baseFilter.js';
* @example * @example
* *
* const users = [ * const users = [
* { 'user': 'barney', 'age': 36, 'active': true }, * { 'user': 'barney', 'active': true },
* { 'user': 'fred', 'age': 40, 'active': false } * { 'user': 'fred', 'active': false }
* ]; * ];
* *
* filter(users, o => !o.active); * filter(users, ({ active }) => active);
* // => objects for ['fred'] * // => objects for ['barney']
*/ */
function filter(collection, predicate) { function filter(collection, predicate) {
const func = Array.isArray(collection) ? arrayFilter : baseFilter; const func = Array.isArray(collection) ? arrayFilter : baseFilter;

View File

@@ -20,7 +20,7 @@ import findIndex from './findIndex.js';
* { 'user': 'pebbles', 'age': 1, 'active': true } * { 'user': 'pebbles', 'age': 1, 'active': true }
* ]; * ];
* *
* find(users, o => o.age < 40); * find(users, ({ age }) => age < 40);
* // => object for 'barney' * // => object for 'barney'
*/ */
const find = createFind(findIndex); const find = createFind(findIndex);

View File

@@ -22,7 +22,7 @@ const nativeMax = Math.max;
* { 'user': 'pebbles', 'active': true } * { 'user': 'pebbles', 'active': true }
* ]; * ];
* *
* findIndex(users, o => o.user == 'barney'); * findIndex(users, ({ user }) => user == 'barney');
* // => 0 * // => 0
*/ */
function findIndex(array, predicate, fromIndex) { function findIndex(array, predicate, fromIndex) {

View File

@@ -19,7 +19,7 @@ import baseForOwn from './.internal/baseForOwn.js';
* 'pebbles': { 'age': 1, 'active': true } * 'pebbles': { 'age': 1, 'active': true }
* }; * };
* *
* findKey(users, o => o.age < 40); * findKey(users, ({ age }) => age < 40);
* // => 'barney' (iteration order is not guaranteed) * // => 'barney' (iteration order is not guaranteed)
*/ */
function findKey(object, predicate) { function findKey(object, predicate) {

View File

@@ -23,7 +23,7 @@ const nativeMin = Math.min;
* { 'user': 'pebbles', 'active': false } * { 'user': 'pebbles', 'active': false }
* ]; * ];
* *
* findLastIndex(users, o => o.user == 'pebbles'); * findLastIndex(users, ({ user }) => user == 'pebbles');
* // => 2 * // => 2
*/ */
function findLastIndex(array, predicate, fromIndex) { function findLastIndex(array, predicate, fromIndex) {

View File

@@ -19,7 +19,7 @@ import baseForOwnRight from './.internal/baseForOwnRight.js';
* 'pebbles': { 'age': 1, 'active': true } * 'pebbles': { 'age': 1, 'active': true }
* }; * };
* *
* findLastKey(users, o => o.age < 40); * findLastKey(users, ({ age }) => age < 40);
* // => returns 'pebbles' assuming `findKey` returns 'barney' * // => returns 'pebbles' assuming `findKey` returns 'barney'
*/ */
function findLastKey(object, predicate) { function findLastKey(object, predicate) {

View File

@@ -20,7 +20,7 @@ import baseForOwn from './.internal/baseForOwn.js';
* 'pebbles': { 'user': 'pebbles', 'age': 1 } * 'pebbles': { 'user': 'pebbles', 'age': 1 }
* }; * };
* *
* mapValues(users, o => o.age); * mapValues(users, ({ age }) => age);
* // => { 'fred': 40, 'pebbles': 1 } (iteration order is not guaranteed) * // => { 'fred': 40, 'pebbles': 1 } (iteration order is not guaranteed)
*/ */
function mapValues(object, iteratee) { function mapValues(object, iteratee) {

View File

@@ -14,7 +14,7 @@ import isSymbol from './isSymbol.js';
* *
* const objects = [{ 'n': 1 }, { 'n': 2 }]; * const objects = [{ 'n': 1 }, { 'n': 2 }];
* *
* maxBy(objects, o => o.n); * maxBy(objects, ({ n }) => n);
* // => { 'n': 2 } * // => { 'n': 2 }
*/ */
function maxBy(array, iteratee) { function maxBy(array, iteratee) {

View File

@@ -17,7 +17,7 @@ const NAN = 0 / 0;
* *
* const objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }]; * const objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];
* *
* meanBy(objects, o => o.n); * meanBy(objects, ({ n }) => n);
* // => 5 * // => 5
*/ */
function meanBy(array, iteratee) { function meanBy(array, iteratee) {

View File

@@ -14,7 +14,7 @@ import isSymbol from './isSymbol.js';
* *
* const objects = [{ 'n': 1 }, { 'n': 2 }]; * const objects = [{ 'n': 1 }, { 'n': 2 }];
* *
* minBy(objects, o => o.n); * minBy(objects, ({ n }) => n);
* // => { 'n': 1 } * // => { 'n': 1 }
*/ */
function minBy(array, iteratee) { function minBy(array, iteratee) {

View File

@@ -15,11 +15,11 @@ import negate from './negate.js';
* @example * @example
* *
* const users = [ * const users = [
* { 'user': 'barney', 'age': 36, 'active': false }, * { 'user': 'barney', 'active': true },
* { 'user': 'fred', 'age': 40, 'active': true } * { 'user': 'fred', 'active': false }
* ]; * ];
* *
* reject(users, o => !o.active); * reject(users, ({ active }) => active);
* // => objects for ['fred'] * // => objects for ['fred']
*/ */
function reject(collection, predicate) { function reject(collection, predicate) {

View File

@@ -14,9 +14,9 @@ import baseSortedIndexBy from './.internal/baseSortedIndexBy.js';
* into `array`. * into `array`.
* @example * @example
* *
* const objects = [{ 'x': 4 }, { 'x': 5 }]; * const objects = [{ 'n': 4 }, { 'n': 5 }];
* *
* sortedIndexBy(objects, { 'x': 4 }, o => o.x); * sortedIndexBy(objects, { 'n': 4 }, ({ n }) => n);
* // => 0 * // => 0
*/ */
function sortedIndexBy(array, value, iteratee) { function sortedIndexBy(array, value, iteratee) {

View File

@@ -14,9 +14,9 @@ import baseSortedIndexBy from './.internal/baseSortedIndexBy.js';
* into `array`. * into `array`.
* @example * @example
* *
* const objects = [{ 'x': 4 }, { 'x': 5 }]; * const objects = [{ 'n': 4 }, { 'n': 5 }];
* *
* sortedLastIndexBy(objects, { 'x': 4 }, o => o.x); * sortedLastIndexBy(objects, { 'n': 4 }, ({ n }) => n);
* // => 1 * // => 1
*/ */
function sortedLastIndexBy(array, value, iteratee) { function sortedLastIndexBy(array, value, iteratee) {

View File

@@ -14,7 +14,7 @@ import baseSum from './.internal/baseSum.js';
* *
* const objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }]; * const objects = [{ 'n': 4 }, { 'n': 2 }, { 'n': 8 }, { 'n': 6 }];
* *
* sumBy(objects, o => o.n); * sumBy(objects, ({ n }) => n);
* // => 20 * // => 20
*/ */
function sumBy(array, iteratee) { function sumBy(array, iteratee) {

View File

@@ -13,12 +13,12 @@ import baseWhile from './.internal/baseWhile.js';
* @example * @example
* *
* const users = [ * const users = [
* { 'user': 'barney', 'active': true }, * { 'user': 'barney', 'active': false },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': true },
* { 'user': 'pebbles', 'active': false } * { 'user': 'pebbles', 'active': true }
* ]; * ];
* *
* takeRightWhile(users, o => !o.active); * takeRightWhile(users, ({ active }) => active);
* // => objects for ['fred', 'pebbles'] * // => objects for ['fred', 'pebbles']
*/ */
function takeRightWhile(array, predicate) { function takeRightWhile(array, predicate) {

View File

@@ -13,12 +13,12 @@ import baseWhile from './.internal/baseWhile.js';
* @example * @example
* *
* const users = [ * const users = [
* { 'user': 'barney', 'active': false }, * { 'user': 'barney', 'active': true },
* { 'user': 'fred', 'active': false }, * { 'user': 'fred', 'active': true },
* { 'user': 'pebbles', 'active': true } * { 'user': 'pebbles', 'active': false }
* ]; * ];
* *
* takeWhile(users, o => !o.active); * takeWhile(users, ({ active }) => active);
* // => objects for ['barney', 'fred'] * // => objects for ['barney', 'fred']
*/ */
function takeWhile(array, predicate) { function takeWhile(array, predicate) {