nestie 
A tiny (215B) and fast utility to expand a flattened object
This module expands an Object who's keys are delimited/condensed representatives of multiple levels.
By default, the . character is used as a delimiter. This is customizable.
Keys are split using the delimiter, each signifying a new level/depth.
Install
$ npm install --save nestie
Usage
Please see Keys for pathing options
import { nestie } from 'nestie';
nestie({
'a': 'hi',
'b.b.0': 'foo',
'b.b.1': '',
'b.b.3': 'bar',
'b.d': 'hello',
'b.e.a': 'yo',
'b.e.b': null,
'b.e.c': 'sup',
'b.e.d': 0,
'b.e.f.0.foo': 123,
'b.e.f.0.bar': 123,
'b.e.f.1.foo': 465,
'b.e.f.1.bar': 456,
'c': 'world'
});
//=> {
//=> a: 'hi',
//=> b: {
//=> b: ['foo', '', , 'bar'],
//=> d: 'hello',
//=> e: {
//=> a: 'yo',
//=> b: null,
//=> c: 'sup',
//=> d: 0,
//=> f: [
//=> { foo: 123, bar: 123 },
//=> { foo: 465, bar: 456 },
//=> ]
//=> }
//=> },
//=> c: 'world'
//=> }Keys
Here are additional examples using different key-notation combinations in order represent different Array/Object structures.
nestie({
'hello.there': 123,
'hello.world': 456,
});
//=> {
//=> hello: {
//=> there: 123,
//=> world: 456
//=> }
//=> }
nestie({
'foo.0.bar': 1,
'foo.1': 'hello',
'foo.2.bar': 3,
});
//=> {
//=> foo: [
//=> { bar: 1 },
//=> 'hello',
//=> { bar: 3 }
//=> ]
//=> }
nestie({
'0.0': 'foo',
'0.1': 'bar',
'1.foo.bar': 123,
'1.foo.baz.0': 4,
'1.foo.baz.1': 5,
'1.foo.baz.2': 6,
'1.hello': 'world',
'2': 'howdy'
});
//=> [
//=> ['foo', 'bar'],
//=> {
//=> foo: {
//=> bar: 123,
//=> baz: [4, 5, 6]
//=> },
//=> hello: 'world'
//=> },
//=> 'howdy'
//=> ]API
nestie(input, delimiter?)
Returns: Object or Array
Returns a new Object or Array, depending on the keys.
Note: A
nullorundefinedinput will returnundefined~!
input
Type: Object
The object to expand.
delimiter
Type: String
Default: .
The "glue" used to join multi-level keys together.
Keys will be split using this delimiter string, signifying a new level/depth.
const input = {
'foo.bar': 123,
'hello_world': 456,
};
nestie(input);
//=> {
//=> foo: { bar: 123 },
//=> hello_world: 456,
//=> }
nestie(input, '_');
//=> {
//=> 'foo.bar': 123,
//=> hello: { world: 456 },
//=> }Benchmarks
Running on Node.js v18.12.1
Note: The
βdenotes that the candidate has a different API and is not a direct comparison.
Load Time:
dset 0.421ms
lodash/set 5.472ms
flat 0.926ms
nestie 0.131ms
Validation:
β lodash/set β (FAILED) @ "array w/ holes"
β dset β (FAILED) @ "array w/ holes"
β flat.unflatten
β nestie
Benchmark:
lodash/set β x 365,431 ops/sec Β±0.46% (96 runs sampled)
dset β x 528,696 ops/sec Β±0.12% (99 runs sampled)
flat.unflatten x 235,161 ops/sec Β±0.16% (98 runs sampled)
nestie x 565,665 ops/sec Β±0.13% (99 runs sampled)
Related
- flattie β flatten an object using customizable glue in 187 bytes
This isnestie's reverse / counterpart. - dset β safely write deep Object values in 160 bytes
- dlv β safely read from deep properties in 120 bytes
License
MIT Β© Luke Edwards