node package manager

deep-get-set

deep-get-set

Set and get values on objects via dot-notation strings.

testling badge

Example

var deep = require('deep-get-set');
 
var obj = {
  foo: {
    bar: 'baz',
    'bar.baz': 'qux'
  }
};
 
// Get 
console.log(deep(obj, 'foo.bar'));
  // => "baz" 
 
// Get with array 
console.log(deep(obj, ['foo', 'bar.baz']));
  // => "qux" 
 
// Set 
deep(obj, 'foo.bar', 'hello');
console.log(obj.foo.bar);
  // => "hello" 
 
// Set with array 
deep(obj, ['foo', 'bar.baz'], 'goodbye');
console.log(obj.foo['bar.baz']);
  // => "goodbye" 

API

deep(object, path[, value])

Where path is a dot-notation string foo.bar or an array of strings.

  • If value is passed it will be set on the path.
  • Set deep.p = true if you want non-existent paths to be initialized.
  • If you want to unset (or delete), pass undefined as the value.

Installation

With npm do:

npm install deep-get-set

Note

There's a dozen modules like this on npm. This is a fork from @juliangruber's deep-access module, with a big portion of code directly copied from here: https://github.com/substack/js-traverse/blob/master/index.js#L11-L18.

Similar modules:

License

MIT

Use this within your firewall

Combine open-source packages with your private code and publish to a private registry behind the firewall. npm ♥ enterprise developers

how? learn more

Collaborators list

Stats

Try it out

Keywords

deep, object, access, property, utility, nested, string

Dependencies

None

Dependents (29)

apostrophe, signalk-server, normalize-obj, lackey-form-data, bixby-common, tinydoc, hive-dev, lackey-request-handler, reactionary-domination, react-autocomplete-temp-fork, require-lazy-loader, decisions, sindri, lackey-mongoose-utils, hapi-dynamic-scope, acm, react-simple-table, json-schema-docs-generator, apostrophe-localization, lackey-inline-edit, object-filters, hapi-inferred-scopes, and more