lodash / lodash

Cannot retrieve contributors at this time

33 lines (31 sloc) 795 Bytes

Raw Blame

	import baseUnset from './.internal/baseUnset.js'

	/**
	* Removes the property at `path` of `object`.
	*
	* Note: This method mutates `object`.
	*
	* @since 4.0.0
	* @category Object
	* @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 get, has, set
	* @example
	*
	* const object = { 'a': [{ 'b': { 'c': 7 } }] }
	* unset(object, 'a[0].b.c')
	* // => true
	*
	* console.log(object)
	* // => { 'a': [{ 'b': {} }] }
	*
	* unset(object, ['a', '0', 'b', 'c'])
	* // => true
	*
	* console.log(object)
	* // => { 'a': [{ 'b': {} }] }
	*/
	function unset(object, path) {
	return object == null ? true : baseUnset(object, path)
	}

	export default unset

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