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@^5.6.0/edition-deno/index.ts'

Skypack

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

unpkg

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

jspm

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

Editions

This package is published with the following editions:

getsetdeep aliases getsetdeep/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
getsetdeep/source/index.ts is TypeScript source code with Import for modules
getsetdeep/edition-browsers/index.js is TypeScript compiled against ES2022 for web browsers with Import for modules
getsetdeep/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
getsetdeep/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
getsetdeep/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
getsetdeep/edition-types/index.d.ts is TypeScript compiled Types 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.

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

Benjamin Lupton — view contributions
Sean Fridman — view contributions

Finances

<a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/bad

Getsetdeep

Install / Use

README