diff --git a/camelCase.js b/camelCase.js index 6a869e22d..2388fa6f1 100644 --- a/camelCase.js +++ b/camelCase.js @@ -8,6 +8,7 @@ import createCompounder from './.internal/createCompounder.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the camel cased string. + * @see upperCase, lowerCase, upperFirst, kebabCase, snakeCase, startCase * @example * * camelCase('Foo Bar'); diff --git a/difference.js b/difference.js index 0f9baded9..83d572d54 100644 --- a/difference.js +++ b/difference.js @@ -15,7 +15,7 @@ import isArrayLikeObject from './isArrayLikeObject.js'; * @param {Array} array The array to inspect. * @param {...Array} [values] The values to exclude. * @returns {Array} Returns the new array of filtered values. - * @see without, xor + * @see without, xor, xorBy, xorWith, union, unionBy, unionWith * @example * * difference([2, 1], [2, 3]); diff --git a/endsWith.js b/endsWith.js index 8dadaf530..1c4f5cb92 100644 --- a/endsWith.js +++ b/endsWith.js @@ -13,6 +13,7 @@ import toString from './toString.js'; * @param {number} [position=string.length] The position to search up to. * @returns {boolean} Returns `true` if `string` ends with `target`, * else `false`. + * @see includes, startsWith * @example * * endsWith('abc', 'c'); diff --git a/escape.js b/escape.js index 0e244b23c..eab6514cb 100644 --- a/escape.js +++ b/escape.js @@ -34,6 +34,7 @@ const reHasUnescapedHtml = RegExp(reUnescapedHtml.source); * @category String * @param {string} [string=''] The string to escape. * @returns {string} Returns the escaped string. + * @see unescape, escapeRegExp * @example * * escape('fred, barney, & pebbles'); diff --git a/escapeRegExp.js b/escapeRegExp.js index 2f6d07583..29e1491c0 100644 --- a/escapeRegExp.js +++ b/escapeRegExp.js @@ -15,6 +15,7 @@ const reHasRegExpChar = RegExp(reRegExpChar.source); * @category String * @param {string} [string=''] The string to escape. * @returns {string} Returns the escaped string. + * @see unescape, escape, escapeRegExp * @example * * escapeRegExp('[lodash](https://lodash.com/)'); diff --git a/filter.js b/filter.js index 4f26d3570..3a98b75b4 100644 --- a/filter.js +++ b/filter.js @@ -13,7 +13,7 @@ import baseFilter from './.internal/baseFilter.js'; * @param {Array|Object} collection The collection to iterate over. * @param {Function} predicate The function invoked per iteration. * @returns {Array} Returns the new filtered array. - * @see reject + * @see pull, pullAll, pullAllBy, pullAllWith, pullAt, remove, reject * @example * * const users = [ diff --git a/find.js b/find.js index 2996676a3..610ed033d 100644 --- a/find.js +++ b/find.js @@ -12,6 +12,7 @@ import findIndex from './findIndex.js'; * @param {Function} predicate The function invoked per iteration. * @param {number} [fromIndex=0] The index to search from. * @returns {*} Returns the matched element, else `undefined`. + * @see findIndex, findKey, findLast, findLastIndex, findLastKey * @example * * const users = [ diff --git a/findIndex.js b/findIndex.js index 378b59095..39c099e61 100644 --- a/findIndex.js +++ b/findIndex.js @@ -14,6 +14,7 @@ const nativeMax = Math.max; * @param {Function} predicate The function invoked per iteration. * @param {number} [fromIndex=0] The index to search from. * @returns {number} Returns the index of the found element, else `-1`. + * @see find, findKey, findLast, findLastIndex, findLastKey * @example * * const users = [ diff --git a/findKey.js b/findKey.js index ea98c6efa..4f291aea5 100644 --- a/findKey.js +++ b/findKey.js @@ -11,6 +11,7 @@ import baseForOwn from './.internal/baseForOwn.js'; * @param {Function} predicate The function invoked per iteration. * @returns {string|undefined} Returns the key of the matched element, * else `undefined`. + * @see find, findIndex, findLast, findLastIndex, findLastKey * @example * * const users = { diff --git a/findLast.js b/findLast.js index f82aae975..c6b91d8a3 100644 --- a/findLast.js +++ b/findLast.js @@ -11,6 +11,7 @@ import findLastIndex from './findLastIndex.js'; * @param {Function} predicate The function invoked per iteration. * @param {number} [fromIndex=collection.length-1] The index to search from. * @returns {*} Returns the matched element, else `undefined`. + * @see find, findIndex, findKey, findLastIndex, findLastKey * @example * * findLast([1, 2, 3, 4], n => n % 2 == 1); diff --git a/findLastIndex.js b/findLastIndex.js index 7de716b8d..d0e772837 100644 --- a/findLastIndex.js +++ b/findLastIndex.js @@ -15,6 +15,7 @@ const nativeMin = Math.min; * @param {Function} predicate The function invoked per iteration. * @param {number} [fromIndex=array.length-1] The index to search from. * @returns {number} Returns the index of the found element, else `-1`. + * @see find, findIndex, findKey, findLast, findLastKey * @example * * const users = [ diff --git a/findLastKey.js b/findLastKey.js index 768255e15..b4907cf2c 100644 --- a/findLastKey.js +++ b/findLastKey.js @@ -11,6 +11,7 @@ import baseForOwnRight from './.internal/baseForOwnRight.js'; * @param {Function} predicate The function invoked per iteration. * @returns {string|undefined} Returns the key of the matched element, * else `undefined`. + * @see find, findIndex, findKey, findLast, findLastIndex * @example * * const users = { diff --git a/flatMap.js b/flatMap.js index 78c7adeec..46c5e6c0a 100644 --- a/flatMap.js +++ b/flatMap.js @@ -11,6 +11,7 @@ import map from './map.js'; * @param {Array|Object} collection The collection to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Array} Returns the new flattened array. + * @see map, mapKeys, mapValues, flatMapDeep, flatMapDepth, flatten, flattenDeep, flattenDepth * @example * * function duplicate(n) { diff --git a/flatMapDeep.js b/flatMapDeep.js index d00c37186..ce9e0bbf9 100644 --- a/flatMapDeep.js +++ b/flatMapDeep.js @@ -13,6 +13,7 @@ const INFINITY = 1 / 0; * @param {Array|Object} collection The collection to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Array} Returns the new flattened array. + * @see map, mapKeys, mapValues, flatMap, flatMapDepth, flatten, flattenDeep, flattenDepth * @example * * function duplicate(n) { diff --git a/flatMapDepth.js b/flatMapDepth.js index b65a96d22..ba7961dc6 100644 --- a/flatMapDepth.js +++ b/flatMapDepth.js @@ -12,6 +12,7 @@ import toInteger from './toInteger.js'; * @param {Function} iteratee The function invoked per iteration. * @param {number} [depth=1] The maximum recursion depth. * @returns {Array} Returns the new flattened array. + * @see map, mapKeys, mapValues, flatMap, flatMapDeep, flatten, flattenDeep, flattenDepth * @example * * function duplicate(n) { diff --git a/flatten.js b/flatten.js index 6e93a3d58..d6b830ab9 100644 --- a/flatten.js +++ b/flatten.js @@ -7,6 +7,7 @@ import baseFlatten from './.internal/baseFlatten.js'; * @category Array * @param {Array} array The array to flatten. * @returns {Array} Returns the new flattened array. + * @see flatMap, flatMapDeep, flatMapDepth, flattenDeep, flattenDepth * @example * * flatten([1, [2, [3, [4]], 5]]); diff --git a/flattenDeep.js b/flattenDeep.js index fe1b6389d..6fa594aff 100644 --- a/flattenDeep.js +++ b/flattenDeep.js @@ -10,6 +10,7 @@ const INFINITY = 1 / 0; * @category Array * @param {Array} array The array to flatten. * @returns {Array} Returns the new flattened array. + * @see flatMap, flatMapDeep, flatMapDepth, flatten, flattenDepth * @example * * flattenDeep([1, [2, [3, [4]], 5]]); diff --git a/flattenDepth.js b/flattenDepth.js index fc8d93cd7..d0aed84c5 100644 --- a/flattenDepth.js +++ b/flattenDepth.js @@ -9,6 +9,7 @@ import toInteger from './toInteger.js'; * @param {Array} array The array to flatten. * @param {number} [depth=1] The maximum recursion depth. * @returns {Array} Returns the new flattened array. + * @see flatMap, flatMapDeep, flatMapDepth, flattenDeep * @example * * const array = [1, [2, [3, [4]], 5]]; diff --git a/flip.js b/flip.js index 741a68003..107731410 100644 --- a/flip.js +++ b/flip.js @@ -10,6 +10,7 @@ const WRAP_FLIP_FLAG = 512; * @category Function * @param {Function} func The function to flip arguments for. * @returns {Function} Returns the new flipped function. + * @see reverse * @example * * const flipped = flip((...args) => args); diff --git a/forEach.js b/forEach.js index 439874659..30565ddd9 100644 --- a/forEach.js +++ b/forEach.js @@ -16,7 +16,7 @@ import baseEach from './.internal/baseEach.js';; * @param {Array|Object} collection The collection to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Array|Object} Returns `collection`. - * @see forEachRight + * @see forEachRight, forIn, forInRight, forOwn, forOwnRight * @example * * forEach([1, 2], value => console.log(value)); diff --git a/forEachRight.js b/forEachRight.js index f09017ca7..474a5ba39 100644 --- a/forEachRight.js +++ b/forEachRight.js @@ -11,7 +11,7 @@ import baseEachRight from './.internal/baseEachRight.js'; * @param {Array|Object} collection The collection to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Array|Object} Returns `collection`. - * @see forEach + * @see forEach, forIn, forInRight, forOwn, forOwnRight * @example * * forEachRight([1, 2], value => console.log(value)); diff --git a/forIn.js b/forIn.js index 514abc386..879c4ba6e 100644 --- a/forIn.js +++ b/forIn.js @@ -12,7 +12,7 @@ import keysIn from './keysIn.js'; * @param {Object} object The object to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Object} Returns `object`. - * @see forInRight + * @see forEach, forEachRight, forInRight, forOwn, forOwnRight * @example * * function Foo() { diff --git a/forInRight.js b/forInRight.js index c2bc0707d..923b8ff3c 100644 --- a/forInRight.js +++ b/forInRight.js @@ -10,7 +10,7 @@ import keysIn from './keysIn.js'; * @param {Object} object The object to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Object} Returns `object`. - * @see forIn + * @see forEach, forEachRight, forIn, forOwn, forOwnRight * @example * * function Foo() { diff --git a/forOwn.js b/forOwn.js index 8e75408f8..ade4a70af 100644 --- a/forOwn.js +++ b/forOwn.js @@ -11,7 +11,7 @@ import baseForOwn from './.internal/baseForOwn.js'; * @param {Object} object The object to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Object} Returns `object`. - * @see forOwnRight + * @see forEach, forEachRight, forIn, forInRight, forOwnRight * @example * * function Foo() { diff --git a/forOwnRight.js b/forOwnRight.js index 7cc727c83..93490225d 100644 --- a/forOwnRight.js +++ b/forOwnRight.js @@ -9,7 +9,7 @@ import baseForOwnRight from './.internal/baseForOwnRight.js'; * @param {Object} object The object to iterate over. * @param {Function} iteratee The function invoked per iteration. * @returns {Object} Returns `object`. - * @see forOwn + * @see forEach, forEachRight, forIn, forInRight, forOwn * @example * * function Foo() { diff --git a/get.js b/get.js index 36c4a1bf0..2f250c463 100644 --- a/get.js +++ b/get.js @@ -10,6 +10,7 @@ import baseGet from './.internal/baseGet.js'; * @param {Array|string} path The path of the property to get. * @param {*} [defaultValue] The value returned for `undefined` resolved values. * @returns {*} Returns the resolved value. + * @see has, hasIn, set, unset * @example * * const object = { 'a': [{ 'b': { 'c': 3 } }] }; diff --git a/gt.js b/gt.js index 70ac8da87..f4916aef9 100644 --- a/gt.js +++ b/gt.js @@ -9,7 +9,7 @@ import toNumber from './toNumber.js'; * @param {*} other The other value to compare. * @returns {boolean} Returns `true` if `value` is greater than `other`, * else `false`. - * @see lt + * @see lt, gte, lte * @example * * gt(3, 1); diff --git a/gte.js b/gte.js index cb936c8b6..11c1accc9 100644 --- a/gte.js +++ b/gte.js @@ -9,7 +9,7 @@ import toNumber from './toNumber.js'; * @param {*} other The other value to compare. * @returns {boolean} Returns `true` if `value` is greater than or equal to * `other`, else `false`. - * @see lte + * @see gt, lt, lte * @example * * gte(3, 1); diff --git a/has.js b/has.js index 27024799b..c5713be48 100644 --- a/has.js +++ b/has.js @@ -9,6 +9,7 @@ import hasPath from './.internal/hasPath.js'; * @param {Object} object The object to query. * @param {Array|string} path The path to check. * @returns {boolean} Returns `true` if `path` exists, else `false`. + * @see hasIn, set, get * @example * * const object = { 'a': { 'b': 2 } }; diff --git a/hasIn.js b/hasIn.js index 41b39445e..f9a2ff1e6 100644 --- a/hasIn.js +++ b/hasIn.js @@ -9,6 +9,7 @@ import hasPath from './.internal/hasPath.js'; * @param {Object} object The object to query. * @param {Array|string} path The path to check. * @returns {boolean} Returns `true` if `path` exists, else `false`. + * @see has, set, get, unset * @example * * const object = create({ 'a': create({ 'b': 2 }) }); diff --git a/head.js b/head.js index ddfd7e902..fb2dbf1c1 100644 --- a/head.js +++ b/head.js @@ -6,6 +6,7 @@ * @category Array * @param {Array} array The array to query. * @returns {*} Returns the first element of `array`. + * @see last * @example * * head([1, 2, 3]); diff --git a/includes.js b/includes.js index 529ffb576..a7384774d 100644 --- a/includes.js +++ b/includes.js @@ -21,6 +21,7 @@ const nativeMax = Math.max; * @param {number} [fromIndex=0] The index to search from. * @param- {Object} [guard] Enables use as an iteratee for methods like `reduce`. * @returns {boolean} Returns `true` if `value` is found, else `false`. + * @see startsWith, endsWith * @example * * includes([1, 2, 3], 1); diff --git a/isInteger.js b/isInteger.js index fbc71a280..51b7672de 100644 --- a/isInteger.js +++ b/isInteger.js @@ -10,6 +10,7 @@ import toInteger from './toInteger.js'; * @category Lang * @param {*} value The value to check. * @returns {boolean} Returns `true` if `value` is an integer, else `false`. + * @see toInteger, isNumber, toNumber * @example * * isInteger(3); diff --git a/isNumber.js b/isNumber.js index f8db485dd..3c1ab469a 100644 --- a/isNumber.js +++ b/isNumber.js @@ -11,6 +11,7 @@ import isObjectLike from './isObjectLike.js'; * @category Lang * @param {*} value The value to check. * @returns {boolean} Returns `true` if `value` is a number, else `false`. + * @see isInteger, toInteger, toNumber * @example * * isNumber(3); diff --git a/kebabCase.js b/kebabCase.js index 75abd3f65..4a884d2f6 100644 --- a/kebabCase.js +++ b/kebabCase.js @@ -8,6 +8,7 @@ import createCompounder from './.internal/createCompounder.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the kebab cased string. + * @see upperCase, lowerCase, upperFirst, camelCase, snakeCase, startCase * @example * * kebabCase('Foo Bar'); diff --git a/keyBy.js b/keyBy.js index 5259b0b71..d9f141ff6 100644 --- a/keyBy.js +++ b/keyBy.js @@ -12,6 +12,7 @@ import reduce from './reduce.js'; * @param {Array|Object} collection The collection to iterate over. * @param {Function} iteratee The iteratee to transform keys. * @returns {Object} Returns the composed aggregate object. + * @see groupBy, partition * @example * * const array = [ diff --git a/keys.js b/keys.js index 3a3bdd17e..928a86014 100644 --- a/keys.js +++ b/keys.js @@ -13,6 +13,7 @@ import isArrayLike from './isArrayLike.js'; * @category Object * @param {Object} object The object to query. * @returns {Array} Returns the array of property names. + * @see values, valuesIn * @example * * function Foo() { diff --git a/lowerCase.js b/lowerCase.js index ae5adb05d..74435e445 100644 --- a/lowerCase.js +++ b/lowerCase.js @@ -7,6 +7,7 @@ import createCompounder from './.internal/createCompounder.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the lower cased string. + * @see upperCase, upperFirst, camelCase, kebabCase, snakeCase, startCase * @example * * lowerCase('--Foo-Bar--'); diff --git a/lt.js b/lt.js index 9c1801773..194498206 100644 --- a/lt.js +++ b/lt.js @@ -9,7 +9,7 @@ import toNumber from './toNumber.js'; * @param {*} other The other value to compare. * @returns {boolean} Returns `true` if `value` is less than `other`, * else `false`. - * @see gt + * @see gt, lte, gte * @example * * lt(1, 3); diff --git a/lte.js b/lte.js index 114cafadd..c3d41a849 100644 --- a/lte.js +++ b/lte.js @@ -9,7 +9,7 @@ import toNumber from './toNumber.js'; * @param {*} other The other value to compare. * @returns {boolean} Returns `true` if `value` is less than or equal to * `other`, else `false`. - * @see gte + * @see gt, lt, gte * @example * * lte(1, 3); diff --git a/orderBy.js b/orderBy.js index fcd30fe5f..b4c78c1d0 100644 --- a/orderBy.js +++ b/orderBy.js @@ -14,6 +14,7 @@ import baseOrderBy from './.internal/baseOrderBy.js'; * @param {string[]} [orders] The sort orders of `iteratees`. * @param- {Object} [guard] Enables use as an iteratee for methods like `reduce`. * @returns {Array} Returns the new sorted array. + * @see reverse * @example * * const users = [ diff --git a/partition.js b/partition.js index 72cf8c0f7..3973e996a 100644 --- a/partition.js +++ b/partition.js @@ -11,6 +11,7 @@ import reduce from './reduce.js'; * @param {Array|Object} collection The collection to iterate over. * @param {Function} predicate The function invoked per iteration. * @returns {Array} Returns the array of grouped elements. + * @see groupBy, keyBy * @example * * const users = [ diff --git a/pull.js b/pull.js index add12b67e..8a5a18362 100644 --- a/pull.js +++ b/pull.js @@ -13,6 +13,7 @@ import pullAll from './pullAll.js'; * @param {Array} array The array to modify. * @param {...*} [values] The values to remove. * @returns {Array} Returns `array`. + * @see pullAll, pullAllBy, pullAllWith, pullAt, remove, reject * @example * * const array = ['a', 'b', 'c', 'a', 'b', 'c']; diff --git a/pullAll.js b/pullAll.js index 4af651bf5..9a28c1758 100644 --- a/pullAll.js +++ b/pullAll.js @@ -10,6 +10,7 @@ import basePullAll from './.internal/basePullAll.js'; * @param {Array} array The array to modify. * @param {Array} values The values to remove. * @returns {Array} Returns `array`. + * @see pull, pullAllBy, pullAllWith, pullAt, remove, reject * @example * * const array = ['a', 'b', 'c', 'a', 'b', 'c']; diff --git a/pullAllBy.js b/pullAllBy.js index 0523a690d..ad03ffa3f 100644 --- a/pullAllBy.js +++ b/pullAllBy.js @@ -13,6 +13,7 @@ import basePullAll from './.internal/basePullAll.js'; * @param {Array} values The values to remove. * @param {Function} iteratee The iteratee invoked per element. * @returns {Array} Returns `array`. + * @see pull, pullAll, pullAllWith, pullAt, remove, reject * @example * * const array = [{ 'x': 1 }, { 'x': 2 }, { 'x': 3 }, { 'x': 1 }]; diff --git a/pullAllWith.js b/pullAllWith.js index c631725c0..682b57680 100644 --- a/pullAllWith.js +++ b/pullAllWith.js @@ -13,6 +13,7 @@ import basePullAll from './.internal/basePullAll.js'; * @param {Array} values The values to remove. * @param {Function} [comparator] The comparator invoked per element. * @returns {Array} Returns `array`. + * @see pull, pullAll, pullAllBy, pullAt, remove, reject * @example * * const array = [{ 'x': 1, 'y': 2 }, { 'x': 3, 'y': 4 }, { 'x': 5, 'y': 6 }]; diff --git a/pullAt.js b/pullAt.js index 554170fbd..bb7e0661a 100644 --- a/pullAt.js +++ b/pullAt.js @@ -15,6 +15,7 @@ import isIndex from './.internal/isIndex.js'; * @param {Array} array The array to modify. * @param {...(number|number[])} [indexes] The indexes of elements to remove. * @returns {Array} Returns the new array of removed elements. + * @see pull, pullAll, pullAllBy, pullAllWith, remove, reject * @example * * const array = ['a', 'b', 'c', 'd']; diff --git a/random.js b/random.js index 52d66653a..403946760 100644 --- a/random.js +++ b/random.js @@ -24,6 +24,7 @@ const nativeRandom = Math.random; * @param {number} [upper=1] The upper bound. * @param {boolean} [floating] Specify returning a floating-point number. * @returns {number} Returns the random number. + * @see uniqueId * @example * * random(0, 5); diff --git a/reduce.js b/reduce.js index 9355a2dd4..11ae3d544 100644 --- a/reduce.js +++ b/reduce.js @@ -23,7 +23,7 @@ import baseReduce from './.internal/baseReduce.js'; * @param {Function} iteratee The function invoked per iteration. * @param {*} [accumulator] The initial value. * @returns {*} Returns the accumulated value. - * @see reduceRight + * @see reduceRight, transform * @example * * reduce([1, 2], (sum, n) => sum + n, 0); diff --git a/reject.js b/reject.js index df39b2218..af84b6a92 100644 --- a/reject.js +++ b/reject.js @@ -11,7 +11,7 @@ import negate from './negate.js'; * @param {Array|Object} collection The collection to iterate over. * @param {Function} predicate The function invoked per iteration. * @returns {Array} Returns the new filtered array. - * @see filter + * @see pull, pullAll, pullAllBy, pullAllWith, pullAt, remove, filter * @example * * const users = [ diff --git a/remove.js b/remove.js index e09040e32..a21310304 100644 --- a/remove.js +++ b/remove.js @@ -13,6 +13,7 @@ import basePullAt from './.internal/basePullAt.js'; * @param {Array} array The array to modify. * @param {Function} predicate The function invoked per iteration. * @returns {Array} Returns the new array of removed elements. + * @see pull, pullAll, pullAllBy, pullAllWith, pullAt, reject, filter * @example * * const array = [1, 2, 3, 4]; diff --git a/replace.js b/replace.js index ecc1af893..fc062aa5e 100644 --- a/replace.js +++ b/replace.js @@ -12,6 +12,7 @@ import toString from './toString.js'; * @param {RegExp|string} pattern The pattern to replace. * @param {Function|string} replacement The match replacement. * @returns {string} Returns the modified string. + * @see truncate, trim * @example * * replace('Hi Fred', 'Fred', 'Barney'); diff --git a/reverse.js b/reverse.js index 02a07999f..43779d226 100644 --- a/reverse.js +++ b/reverse.js @@ -12,6 +12,7 @@ const nativeReverse = Array.prototype.reverse; * @category Array * @param {Array} array The array to modify. * @returns {Array} Returns `array`. + * @see flip, sortBy * @example * * const array = [1, 2, 3]; diff --git a/set.js b/set.js index 5b5340a7b..1753a853a 100644 --- a/set.js +++ b/set.js @@ -14,6 +14,7 @@ import baseSet from './.internal/baseSet.js'; * @param {Array|string} path The path of the property to set. * @param {*} value The value to set. * @returns {Object} Returns `object`. + * @see has, hasIn, get, unset * @example * * const object = { 'a': [{ 'b': { 'c': 3 } }] }; diff --git a/snakeCase.js b/snakeCase.js index 00776e03b..4c3fbf493 100644 --- a/snakeCase.js +++ b/snakeCase.js @@ -8,6 +8,7 @@ import createCompounder from './.internal/createCompounder.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the snake cased string. + * @see upperCase, lowerCase, upperFirst, camelCase, kebabCase, startCase * @example * * snakeCase('Foo Bar'); diff --git a/startCase.js b/startCase.js index 94fded395..45a3fa823 100644 --- a/startCase.js +++ b/startCase.js @@ -9,6 +9,7 @@ import upperFirst from './upperFirst.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the start cased string. + * @see upperCase, lowerCase, upperFirst, camelCase, kebabCase, snakeCase * @example * * startCase('--foo-bar--'); diff --git a/startsWith.js b/startsWith.js index e9905557a..524e815d0 100644 --- a/startsWith.js +++ b/startsWith.js @@ -13,6 +13,7 @@ import toString from './toString.js'; * @param {number} [position=0] The position to search from. * @returns {boolean} Returns `true` if `string` starts with `target`, * else `false`. + * @see includes, endsWith * @example * * startsWith('abc', 'a'); diff --git a/toInteger.js b/toInteger.js index 80870e5b3..ad1dc69c8 100644 --- a/toInteger.js +++ b/toInteger.js @@ -10,6 +10,7 @@ import toFinite from './toFinite.js'; * @category Lang * @param {*} value The value to convert. * @returns {number} Returns the converted integer. + * @see isInteger, isNumber, toNumber * @example * * toInteger(3.2); diff --git a/toNumber.js b/toNumber.js index 9df93f1ef..d793abd61 100644 --- a/toNumber.js +++ b/toNumber.js @@ -26,6 +26,7 @@ const freeParseInt = parseInt; * @category Lang * @param {*} value The value to process. * @returns {number} Returns the number. + * @see isInteger, toInteger, isNumber * @example * * toNumber(3.2); diff --git a/transform.js b/transform.js index 2262e29d0..6673f56cd 100644 --- a/transform.js +++ b/transform.js @@ -21,6 +21,7 @@ import isTypedArray from './isTypedArray.js'; * @param {Function} iteratee The function invoked per iteration. * @param {*} [accumulator] The custom accumulator value. * @returns {*} Returns the accumulated value. + * @see reduce, reduceRight * @example * * transform([2, 3, 4], (result, n) => { diff --git a/trim.js b/trim.js index 64521efe6..7ddd21181 100644 --- a/trim.js +++ b/trim.js @@ -17,6 +17,7 @@ const reTrim = /^\s+|\s+$/g; * @param {string} [chars=whitespace] The characters to trim. * @param- {Object} [guard] Enables use as an iteratee for methods like `map`. * @returns {string} Returns the trimmed string. + * @see trimEnd, trimStart * @example * * trim(' abc '); diff --git a/trimEnd.js b/trimEnd.js index 0ee68780f..f12f6351d 100644 --- a/trimEnd.js +++ b/trimEnd.js @@ -16,6 +16,7 @@ const reTrimEnd = /\s+$/; * @param {string} [chars=whitespace] The characters to trim. * @param- {Object} [guard] Enables use as an iteratee for methods like `map`. * @returns {string} Returns the trimmed string. + * @see trim, trimStart * @example * * trimEnd(' abc '); diff --git a/trimStart.js b/trimStart.js index ca4161c5b..9b384958a 100644 --- a/trimStart.js +++ b/trimStart.js @@ -16,6 +16,7 @@ const reTrimStart = /^\s+/; * @param {string} [chars=whitespace] The characters to trim. * @param- {Object} [guard] Enables use as an iteratee for methods like `map`. * @returns {string} Returns the trimmed string. + * @see trim, trimEnd * @example * * trimStart(' abc '); diff --git a/truncate.js b/truncate.js index 9a6dce686..9c29d4a3c 100644 --- a/truncate.js +++ b/truncate.js @@ -28,6 +28,7 @@ const reFlags = /\w*$/; * @param {string} [options.omission='...'] The string to indicate text is omitted. * @param {RegExp|string} [options.separator] The separator pattern to truncate to. * @returns {string} Returns the truncated string. + * @see replace * @example * * truncate('hi-diddly-ho there, neighborino'); diff --git a/unescape.js b/unescape.js index bc8162a1a..0077b5afb 100644 --- a/unescape.js +++ b/unescape.js @@ -25,6 +25,7 @@ const reHasEscapedHtml = RegExp(reEscapedHtml.source); * @category String * @param {string} [string=''] The string to unescape. * @returns {string} Returns the unescaped string. + * @see escape, escapeRegExp * @example * * unescape('fred, barney, & pebbles'); diff --git a/union.js b/union.js index 4c4371170..62fb39c57 100644 --- a/union.js +++ b/union.js @@ -11,6 +11,7 @@ import isArrayLikeObject from './isArrayLikeObject.js'; * @category Array * @param {...Array} [arrays] The arrays to inspect. * @returns {Array} Returns the new array of combined values. + * @see unionBy, unionWith, difference, without, xor, xorBy * @example * * union([2], [1, 2]); diff --git a/unionBy.js b/unionBy.js index 16d42bde2..8544c29e7 100644 --- a/unionBy.js +++ b/unionBy.js @@ -15,6 +15,7 @@ import last from './last.js'; * @param {...Array} [arrays] The arrays to inspect. * @param {Function} iteratee The iteratee invoked per element. * @returns {Array} Returns the new array of combined values. + * @see union, unionWith, difference, without, xor, xorBy * @example * * unionBy([2.1], [1.2, 2.3], Math.floor); diff --git a/unionWith.js b/unionWith.js index 4a26dcadf..f3552dc66 100644 --- a/unionWith.js +++ b/unionWith.js @@ -14,6 +14,7 @@ import last from './last.js'; * @param {...Array} [arrays] The arrays to inspect. * @param {Function} [comparator] The comparator invoked per element. * @returns {Array} Returns the new array of combined values. + * @see union, unionBy, difference, without, xor, xorBy * @example * * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; diff --git a/uniq.js b/uniq.js index 8427f654d..7d09cb3c6 100644 --- a/uniq.js +++ b/uniq.js @@ -11,6 +11,7 @@ import baseUniq from './.internal/baseUniq.js'; * @category Array * @param {Array} array The array to inspect. * @returns {Array} Returns the new duplicate free array. + * @see uniqBy, uniqWith * @example * * uniq([2, 1, 2]); diff --git a/uniqBy.js b/uniqBy.js index c23c7881c..ab86ad901 100644 --- a/uniqBy.js +++ b/uniqBy.js @@ -12,6 +12,7 @@ import baseUniq from './.internal/baseUniq.js'; * @param {Array} array The array to inspect. * @param {Function} iteratee The iteratee invoked per element. * @returns {Array} Returns the new duplicate free array. + * @see uniq, uniqWith * @example * * uniqBy([2.1, 1.2, 2.3], Math.floor); diff --git a/uniqWith.js b/uniqWith.js index f97e00538..12cc6dff6 100644 --- a/uniqWith.js +++ b/uniqWith.js @@ -11,6 +11,7 @@ import baseUniq from './.internal/baseUniq.js'; * @param {Array} array The array to inspect. * @param {Function} [comparator] The comparator invoked per element. * @returns {Array} Returns the new duplicate free array. + * @see uniq, uniqBy * @example * * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 2 }]; diff --git a/uniqueId.js b/uniqueId.js index 14053ed41..55f40ebe7 100644 --- a/uniqueId.js +++ b/uniqueId.js @@ -10,6 +10,7 @@ let idCounter = 0; * @category Util * @param {string} [prefix=''] The value to prefix the ID with. * @returns {string} Returns the unique ID. + * @see random * @example * * uniqueId('contact_'); diff --git a/unset.js b/unset.js index f0f95ad9c..3be16e33e 100644 --- a/unset.js +++ b/unset.js @@ -10,6 +10,7 @@ import baseUnset from './.internal/baseUnset.js'; * @param {Object} object The object to modify. * @param {Array|string} path The path of the property to unset. * @returns {boolean} Returns `true` if the property is deleted, else `false`. + * @see has, set, get * @example * * const object = { 'a': [{ 'b': { 'c': 7 } }] }; diff --git a/unzip.js b/unzip.js index d30f18404..94f5d3c67 100644 --- a/unzip.js +++ b/unzip.js @@ -16,6 +16,7 @@ const nativeMax = Math.max; * @category Array * @param {Array} array The array of grouped elements to process. * @returns {Array} Returns the new array of regrouped elements. + * @see zip, zipObject, zipObjectDeep, zipWith, unzipWith * @example * * const zipped = zip(['a', 'b'], [1, 2], [true, false]); diff --git a/upperCase.js b/upperCase.js index 0957a3b56..3b4eae96f 100644 --- a/upperCase.js +++ b/upperCase.js @@ -7,6 +7,7 @@ import createCompounder from './.internal/createCompounder.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the upper cased string. + * @see lowerCase, upperFirst, camelCase, kebabCase, snakeCase, startCase * @example * * upperCase('--foo-bar'); diff --git a/upperFirst.js b/upperFirst.js index 48a5f4ec1..4f2998a5e 100644 --- a/upperFirst.js +++ b/upperFirst.js @@ -7,6 +7,7 @@ import createCaseFirst from './.internal/createCaseFirst.js'; * @category String * @param {string} [string=''] The string to convert. * @returns {string} Returns the converted string. + * @see upperCase, lowerCase, camelCase, kebabCase, snakeCase, startCase * @example * * upperFirst('fred'); diff --git a/values.js b/values.js index 9d17d333d..734993048 100644 --- a/values.js +++ b/values.js @@ -10,6 +10,7 @@ import keys from './keys.js'; * @category Object * @param {Object} object The object to query. * @returns {Array} Returns the array of property values. + * @see keys, valuesIn * @example * * function Foo() { diff --git a/without.js b/without.js index 4d7371608..3ac48663d 100644 --- a/without.js +++ b/without.js @@ -13,7 +13,7 @@ import isArrayLikeObject from './isArrayLikeObject.js'; * @param {Array} array The array to inspect. * @param {...*} [values] The values to exclude. * @returns {Array} Returns the new array of filtered values. - * @see difference, xor + * @see difference, xor, xorBy, xorWith, union, unionBy, unionWith * @example * * without([2, 1, 2, 3], 1, 2); diff --git a/xor.js b/xor.js index ca04ca438..6feaa04f9 100644 --- a/xor.js +++ b/xor.js @@ -12,7 +12,7 @@ import isArrayLikeObject from './isArrayLikeObject.js'; * @category Array * @param {...Array} [arrays] The arrays to inspect. * @returns {Array} Returns the new array of filtered values. - * @see difference, without + * @see difference, without, xorBy, xorWith, union, unionBy, unionWith * @example * * xor([2, 1], [2, 3]); diff --git a/xorBy.js b/xorBy.js index d04aa77f7..c4e1b9603 100644 --- a/xorBy.js +++ b/xorBy.js @@ -15,6 +15,7 @@ import last from './last.js'; * @param {...Array} [arrays] The arrays to inspect. * @param {Function} iteratee The iteratee invoked per element. * @returns {Array} Returns the new array of filtered values. + * @see difference, without, xor, xorWith, union, unionBy, unionWith * @example * * xorBy([2.1, 1.2], [2.3, 3.4], Math.floor); diff --git a/xorWith.js b/xorWith.js index 3610341fc..01bec47f6 100644 --- a/xorWith.js +++ b/xorWith.js @@ -14,6 +14,7 @@ import last from './last.js'; * @param {...Array} [arrays] The arrays to inspect. * @param {Function} [comparator] The comparator invoked per element. * @returns {Array} Returns the new array of filtered values. + * @see difference, without, xor, xorBy, union, unionBy, unionWith * @example * * const objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }]; diff --git a/zip.js b/zip.js index 8249a63b3..b805b5c69 100644 --- a/zip.js +++ b/zip.js @@ -9,6 +9,7 @@ import unzip from './unzip.js'; * @category Array * @param {...Array} [arrays] The arrays to process. * @returns {Array} Returns the new array of grouped elements. + * @see zipObject, zipObjectDeep, zipWith, unzip, unzipWith * @example * * zip(['a', 'b'], [1, 2], [true, false]); diff --git a/zipObject.js b/zipObject.js index fcb450fc7..c3b52faee 100644 --- a/zipObject.js +++ b/zipObject.js @@ -10,6 +10,7 @@ import baseZipObject from './.internal/baseZipObject.js'; * @param {Array} [props=[]] The property identifiers. * @param {Array} [values=[]] The property values. * @returns {Object} Returns the new object. + * @see zip, zipObjectDeep, zipWith, unzip, unzipWith * @example * * zipObject(['a', 'b'], [1, 2]); diff --git a/zipObjectDeep.js b/zipObjectDeep.js index b02380470..cb526d4a7 100644 --- a/zipObjectDeep.js +++ b/zipObjectDeep.js @@ -9,6 +9,7 @@ import baseZipObject from './.internal/baseZipObject.js'; * @param {Array} [props=[]] The property identifiers. * @param {Array} [values=[]] The property values. * @returns {Object} Returns the new object. + * @see zip, zipObject, zipWith, unzip, unzipWith * @example * * zipObjectDeep(['a.b[0].c', 'a.b[1].d'], [1, 2]); diff --git a/zipWith.js b/zipWith.js index 5e60790ba..980c8145f 100644 --- a/zipWith.js +++ b/zipWith.js @@ -11,6 +11,7 @@ import unzipWith from './unzipWith.js'; * @param {Function} iteratee The function to combine * grouped values. * @returns {Array} Returns the new array of grouped elements. + * @see zip, zipObject, zipObjectDeep, zipWith, unzip, unzipWith * @example * * zipWith([1, 2], [10, 20], [100, 200], (a, b, c) => a + b + c);