getsetdeep v5.2.0-next.1700566183.66b8493403c6f6fb82584007cb1c038042cae0f2

Get and set nested variables of an object, includes support for Backbone Models

Usage

Complete API Documentation.

Example

// Import
import { setDeep, getDeep } from 'getsetdeep'

// Prepare
const obj = {
    a: {
        b: {
            c: 3,
        },
    },
}

// Get
console.log(getDeep(obj, 'a.b.c')) // 3
console.log(setDeep(obj, 'a.b.c', 4)) // 4
console.log(getDeep(obj, 'a.b.c')) // 4

Notes

• setDeep also has a fourth argument opts for options, currently we support the options:
  • onlyIfEmpty defaults to false, if specified to true then setDeep will only set the value if the current value is null or undefined
• We also work with getters get(key) and setters set(attrs, opts), enabling support for Backbone.js models as well as others

Security

To satisfy the egos of some security researchers, just as you wouldn't do obj[prompt('some user input')] = 'value' don't do setDeep(obj, prompt('some user input'), 'value'), obviously. Rather than getsetdeep preventing __proto__ access, we assume the consumers of this library are intelligent enough to do what they intend.

npm

Deno

import * as pkg from 'https://unpkg.com/getsetdeep@^5.2.0/edition-deno/index.ts'

Skypack

<script type="module">
    import * as pkg from '//cdn.skypack.dev/getsetdeep@^5.2.0'
</script>

unpkg

<script type="module">
    import * as pkg from '//unpkg.com/getsetdeep@^5.2.0'
</script>

jspm

<script type="module">
    import * as pkg from '//dev.jspm.io/getsetdeep@5.2.0'
</script>

Discover the release history by heading on over to the HISTORY.md file.

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Unless stated otherwise all works are:

and licensed under: