mmckelvy / set-deep-prop

Sets a deeply nested object's value

set-deep-prop

Sets the value for a deeply nested objects and arrays.

Example

const setDeepProp = require('set-deep-prop')

const obj = {
  order: {
    number: 123,
    items: [
      {
        sku: 1,
        description: 'shirt',
      },
      {
        sku: 2,
        description: 'pants'
      }
    ]
  }
}

setDeepProp(obj, ['order', 'items', 1, 'description'], 'hat')
console.log(obj.order.items[1].description) // 'hat'

See test/set-deep-prop.test.js for more examples.

Installation

npm install --save set-deep-prop

API

setDeepProp(obj, path, value)
@param {object} obj -- A deeply nested object
@param {array} path -- The path to the object as an array. Ex: ['topkey', 'nextkey', 0, 'nestedKey']
@param {any} value -- The new value to set.

@return {object} -- The updated object. Note that this method mutates the original object.

Test

npm test

License

MIT

set-deep-prop's Issues

🚨 Potential Security Vulnerability - huntr.dev

⚠️ Potential Vulnerability in set-deep-prop

👋 Hello, @mmckelvy - @ready-research has disclosed a potential vulnerability in your repository. To validate or invalidate this potential vulnerability, please visit https://huntr.dev/bounties/1-npm-set-deep-prop and join our community in helping secure open-source code.

---

☎️ Need further support?

Come and join us on our Discord and a member of our team will be happy to help! 🤗

cc - @JamieSlome