Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
…r strings (#3764)
51 lines (49 sloc)
1.69 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| import baseOrderBy from './.internal/baseOrderBy.js' | |
| /** | |
| * This method is like `sortBy` except that it allows specifying the sort | |
| * orders of the iteratees to sort by. If `orders` is unspecified, all values | |
| * are sorted in ascending order. Otherwise, specify an order of "desc" for | |
| * descending or "asc" for ascending sort order of corresponding values. | |
| * You may also specify a compare function for an order. | |
| * | |
| * @since 4.0.0 | |
| * @category Collection | |
| * @param {Array|Object} collection The collection to iterate over. | |
| * @param {Array[]|Function[]|Object[]|string[]} [iteratees=[identity]] | |
| * The iteratees to sort by. | |
| * @param {(string|function)[]} [orders] The sort orders of `iteratees`. | |
| * @returns {Array} Returns the new sorted array. | |
| * @see reverse | |
| * @example | |
| * | |
| * const users = [ | |
| * { 'user': 'fred', 'age': 48 }, | |
| * { 'user': 'barney', 'age': 34 }, | |
| * { 'user': 'fred', 'age': 40 }, | |
| * { 'user': 'barney', 'age': 36 } | |
| * ] | |
| * | |
| * // Sort by `user` in ascending order and by `age` in descending order. | |
| * orderBy(users, ['user', 'age'], ['asc', 'desc']) | |
| * // => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 40]] | |
| * | |
| * // Sort by `user` then by `age` using custom compare functions for each | |
| * orderBy(users, ['user', 'age'], [ | |
| * (a, b) => a.localeCompare(b, 'de', { sensitivity: 'base' }), | |
| * (a, b) => a - b, | |
| * ]) | |
| * | |
| */ | |
| function orderBy(collection, iteratees, orders) { | |
| if (collection == null) { | |
| return [] | |
| } | |
| if (!Array.isArray(iteratees)) { | |
| iteratees = iteratees == null ? [] : [iteratees] | |
| } | |
| if (!Array.isArray(orders)) { | |
| orders = orders == null ? [] : [orders] | |
| } | |
| return baseOrderBy(collection, iteratees, orders) | |
| } | |
| export default orderBy |