lodash / lodash

Cannot retrieve contributors at this time

30 lines (28 sloc) 784 Bytes

Raw Blame

	import baseProperty from './.internal/baseProperty.js'
	import basePropertyDeep from './.internal/basePropertyDeep.js'
	import isKey from './.internal/isKey.js'
	import toKey from './.internal/toKey.js'

	/**
	* Creates a function that returns the value at `path` of a given object.
	*
	* @since 2.4.0
	* @category Util
	* @param {Array\|string} path The path of the property to get.
	* @returns {Function} Returns the new accessor function.
	* @example
	*
	* const objects = [
	* { 'a': { 'b': 2 } },
	* { 'a': { 'b': 1 } }
	* ]
	*
	* map(objects, property('a.b'))
	* // => [2, 1]
	*
	* map(sortBy(objects, property(['a', 'b'])), 'a.b')
	* // => [1, 2]
	*/
	function property(path) {
	return isKey(path) ? baseProperty(toKey(path)) : basePropertyDeep(path)
	}

	export default property

lodash/property.js / Jump to Code definitions property Function Code navigation index up-to-date