README
getsetdeep
Get and set nested variables of an object, includes support for Backbone Models
Usage
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 argumentopts
for options, currently we support the options:onlyIfEmpty
defaults tofalse
, if specified totrue
thensetDeep
will only set the value if the current value isnull
orundefined
- We also work with getters
get(key)
and settersset(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
- Install:
npm install --save getsetdeep
- Import:
import * as pkg from ('getsetdeep')
- Require:
const pkg = require('getsetdeep')
<script type="module">
import * as pkg from '//cdn.skypack.dev/getsetdeep@^4.18.0'
</script>
<script type="module">
import * as pkg from '//unpkg.com/getsetdeep@^4.18.0'
</script>
<script type="module">
import * as pkg from '//dev.jspm.io/getsetdeep@4.18.0'
</script>
Editions
This package is published with the following editions:
getsetdeep/source/index.ts
is TypeScript source code with Import for modulesgetsetdeep/edition-browsers/index.js
is TypeScript compiled against ES2020 for web browsers with Import for modulesgetsetdeep
aliasesgetsetdeep/edition-es2019/index.js
getsetdeep/edition-es2019/index.js
is TypeScript compiled against ES2019 for Node.js 10 || 12 || 14 || 16 with Require for modulesgetsetdeep/edition-es2019-esm/index.js
is TypeScript compiled against ES2019 for Node.js 12 || 14 || 16 with Import for modules
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:
Sponsors
No sponsors yet! Will you be the first?
Contributors
These amazing people have contributed code to this project:
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: