bevry
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')) // 4Notes
setDeepalso has a fourth argumentoptsfor options, currently we support the options:onlyIfEmptydefaults tofalse, if specified totruethensetDeepwill only set the value if the current value isnullorundefined
- 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
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:
getsetdeepaliasesgetsetdeep/index.cjswhich uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentgetsetdeep/source/index.tsis TypeScript source code with Import for modulesgetsetdeep/edition-browsers/index.jsis TypeScript compiled against ES2022 for web browsers with Import for modulesgetsetdeep/edition-es2022/index.jsis TypeScript compiled against ES2022 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesgetsetdeep/edition-es5/index.jsis TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesgetsetdeep/edition-es2022-esm/index.jsis TypeScript compiled against ES2022 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modulesgetsetdeep/edition-types/index.d.tsis TypeScript compiled Types with Import for modulesgetsetdeep/edition-deno/index.tsis 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
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under: