Flatten and eXpand for Javascript Objects.
$ npm install object-fx
Basic example:
const objectFx = require('object-fx')
let nestedObject = {
hello: {
world: [1, 2, 3, '!']
}
}
let flattened = objectFx.flatten(nestedObject)
console.log(flattened)
/*
{
'hello.world.0': 1,
'hello.world.1': 2,
'hello.world.2': 3,
'hello.world.3': '!',
}
*/
let expanded = objectFx.expand(flattened)
console.log(expanded)
/*
{
hello: {
world: [1, 2, 3, '!']
}
}
*/
- Directly utilize redis hashes: Store, manipulate and retrieve Javascript object data easily
- Simplify updates of e.g. MongoDB documents: Don't lose unset properties by using dot notation
- For convenience and "because of the clarity" (e.g. data conversion, debug output)
- ...add your own here!
Flattens an object.
CircularityCheck
{Boolean}, defaults to false
Perform a check for circular references before flattening an object.
Without prior testing circular objects will throw RangeError: Maximum call stack size exceeded
.
CustomDelimiter
{String}, defaults to '.' (dot)
You can use any char or character chain, but avoid those that are already used within keys.
ExplicitArrays
{Boolean}, defaults to false
If set to true
arrays are flattened in bracket notation, e.g. to arr[0]
instead of arr.0
MaxDepth
{Number}, defaults to 0
Maximum number of (nested) levels to flatten.
Example:
const objectFx = require('object-fx')
const nestedObject = {
lets: {
count: [1, 2, 3, '...']
},
Is: {
this: {
deeply: {
nested: {
'?': 'YEES!!!'
}
}
}
}
}
let flattened = objectFx.flatten(nestedObject, { ExplicitArrays: true, MaxDepth: 3 })
console.log(flattened)
/*
{
'lets.count[0]': 1,
'lets.count[1]': 2,
'lets.count[2]': 3,
'lets.count[3]': '...',
'Is.this.deeply': {
nested: {
'?': 'YEES!!!'
}
}
}
*/
Expands an object.
AutocreateArrays
{Boolean}, defaults to true
Per default, keys consisting of whole numbers are expanded to array indices, e.g. { a.0: 'value'}
โ { a: [ 'value' ] }
Set this option to false
to create object keys instead: { a.0: 'value'}
โ { a: { 0: 'value' }
CustomDelimiter
{String}, defaults to '.' (dot)
You can use any char or character chain, but avoid those that are already used within keys.
ExplicitArrays
{Boolean}, defaults to false
If set to true
, bracket notations like arr[0]
will be expanded into arrays, otherwise ignored.
Example:
const objectFx = require('object-fx')
let flatObject = {
'lets.count[0]': 1,
'lets.count[1]': 2,
'lets.count[2]': 3,
'lets.count[3]': '...',
'Is.this.deeply.nested.?': 'YEES!!!'
}
let expanded = objectFx.expand(flatObject, { ExplicitArrays: true })
console.log(expanded)
/*
{
lets: {
count: [1, 2, 3, '...']
},
Is: {
this: {
deeply: {
nested: {
'?': 'YEES!!!'
}
}
}
}
}
*/
Expands an object (alternate method name).
Uses expand under the hood.
ISC