Files
lodash/property.js
John-David Dalton 54e7baecc3 Bump to v4.0.0.
2016-01-12 00:17:29 -08:00

31 lines
768 B
JavaScript

import baseProperty from './internal/baseProperty';
import basePropertyDeep from './internal/basePropertyDeep';
import isKey from './internal/isKey';
/**
* Creates a function that returns the value at `path` of a given object.
*
* @static
* @memberOf _
* @category Util
* @param {Array|string} path The path of the property to get.
* @returns {Function} Returns the new function.
* @example
*
* var objects = [
* { 'a': { 'b': { 'c': 2 } } },
* { 'a': { 'b': { 'c': 1 } } }
* ];
*
* _.map(objects, _.property('a.b.c'));
* // => [2, 1]
*
* _.map(_.sortBy(objects, _.property(['a', 'b', 'c'])), 'a.b.c');
* // => [1, 2]
*/
function property(path) {
return isKey(path) ? baseProperty(path) : basePropertyDeep(path);
}
export default property;