Get or set nested variables of an object
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
example.js
index.js
package-lock.json
package.json
test.js

README.md

getsetdeep

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

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

Install

NPM

  • Install: npm install --save getsetdeep
  • Module: require('getsetdeep')

Browserify

  • Install: npm install --save getsetdeep
  • Module: require('getsetdeep')
  • CDN URL: //wzrd.in/bundle/getsetdeep@3.0.0

Ender

  • Install: ender add getsetdeep
  • Module: require('getsetdeep')

Editions

This package is published with the following editions:

  • getsetdeep aliases getsetdeep/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • getsetdeep/source/index.js is Source + ESNext + Require
  • getsetdeep/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

Example

// Import
const getsetdeep = require('getsetdeep');

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

// Get
console.log(getsetdeep.getDeep(obj, 'a.b.c'));     // 3
console.log(getsetdeep.setDeep(obj, 'a.b.c', 4));  // 4
console.log(getsetdeep.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

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?

Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

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:

and licensed under: