getsetdeep

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.

Install

npm

• Install: npm install --save getsetdeep
• Import: import * as pkg from ('getsetdeep')
• Require: const pkg = require('getsetdeep')

Deno

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

Skypack

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

unpkg

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

jspm

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

Editions

This package is published with the following editions:

• getsetdeep/source/index.ts is TypeScript source code with Import for modules
• getsetdeep/edition-browsers/index.js is TypeScript compiled against ES2019 for web browsers with Import for modules
• getsetdeep aliases getsetdeep/edition-esnext/index.js
• getsetdeep/edition-esnext/index.js is TypeScript compiled against ESNext for Node.js 10 || 12 || 14 || 15 with Require for modules
• getsetdeep/edition-esnext-esm/index.js is TypeScript compiled against ESNext for Node.js 12 || 14 || 15 with Import for modules
• getsetdeep/edition-deno/index.ts is TypeScript source code made to be compatible with Deno

History

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

Contribute

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

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions
• Sean Fridman — view contributions

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

License

Unless stated otherwise all works are:

• Copyright © Bevry Pty Ltd

and licensed under:

• MIT License