Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mickhansen/dottie.js
Fast and safe nested object access and manipulation in JavaScript
https://github.com/mickhansen/dottie.js
Last synced: about 2 months ago
JSON representation
Fast and safe nested object access and manipulation in JavaScript
- Host: GitHub
- URL: https://github.com/mickhansen/dottie.js
- Owner: mickhansen
- License: mit
- Created: 2012-06-09T21:13:06.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-06-13T06:31:02.000Z (over 1 year ago)
- Last Synced: 2024-05-20T23:09:57.119Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 8.78 MB
- Stars: 249
- Watchers: 10
- Forks: 23
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs - dottie.js - Fast and safe nested object access and manipulation in JavaScript.  (Repository / Object / JSON / JSON Schema)
README
[](https://travis-ci.org/mickhansen/dottie.js)
Dottie helps you easily (and without sacrificing too much performance) look up and play with nested keys in objects, without them throwing up in your face.
**Not actively maintained. You are likely better off using lodash or ES6+**
## Install
npm install dottie
## Usage
For detailed usage, check source or tests.
### Get value
Gets nested value, or undefined if unreachable, or a default value if passed.
```js
var values = {
some: {
nested: {
key: 'foobar';
}
},
'some.dot.included': {
key: 'barfoo'
}
}
dottie.get(values, 'some.nested.key'); // returns 'foobar'
dottie.get(values, 'some.undefined.key'); // returns undefined
dottie.get(values, 'some.undefined.key', 'defaultval'); // returns 'defaultval'
dottie.get(values, ['some.dot.included', 'key']); // returns 'barfoo'
```
*Note: lodash.get() also works fine for this*
### Set value
Sets nested value, creates nested structure if needed
```js
dottie.set(values, 'some.nested.value', someValue);
dottie.set(values, ['some.dot.included', 'value'], someValue);
dottie.set(values, 'some.nested.object', someValue, {
force: true // force overwrite defined non-object keys into objects if needed
});
```
### Transform object
Transform object from keys with dottie notation to nested objects
```js
var values = {
'user.name': 'Gummy Bear',
'user.email': '[email protected]',
'user.professional.title': 'King',
'user.professional.employer': 'Candy Mountain'
};
var transformed = dottie.transform(values);
/*
{
user: {
name: 'Gummy Bear',
email: '[email protected]',
professional: {
title: 'King',
employer: 'Candy Mountain'
}
}
}
*/
```
#### With a custom delimiter
```js
var values = {
'user_name': 'Mick Hansen',
'user_email': '[email protected]'
};
var transformed = dottie.transform(values, { delimiter: '_' });
/*
{
user: {
name: 'Mick Hansen',
email: '[email protected]'
}
}
*/
```
### Get paths in object
```js
var object = {
a: 1,
b: {
c: 2,
d: { e: 3 }
}
};
dottie.paths(object); // ["a", "b.c", "b.d.e"];
```
## Performance
`0.3.1` and up ships with `dottie.memoizePath: true` by default, if this causes any bugs, please try setting it to false
## License
[MIT](https://github.com/mickhansen/dottie.js/blob/master/LICENSE)