deepdash
v5.3.9TypeScript
โ ๐eep standalone lib / ๐odash extension: โ eachDeep โ filterDeep โ mapDeep โ reduceDeep โ pickDeep โ omitDeep โ keysDeep โ index โ condenseDeep โฎ Parents stack โฎ Circular check โฎ Leaves only mode โฎ Children mode โฎ cherry-pick โฎ esm
0/weekUpdated 3 years agoMITUnpacked: 1.4 MB
Published by Yuri Gor
npm install deepdash
Deepdash
eachDeep, filterDeep, findDeep, someDeep, omitDeep, pickDeep, keysDeep etc..
Tree traversal library written in Underscore/Lodash fashion.
Standalone or as a Lodash mixin extension
> Deepdash lib is used in PlanZed.org - awesome cloud mind map app created by the author of deepdash.
Plz check it, it's free and I need feedback ๐
  
$3
#### In a browser
Load script after Lodash, then pass a lodash instance to the deepdash function:
``
html
`If you don't use Lodash - there is a standalone version:
html
`
Standalone Deepdash weighs more then "dry" version, because it includes some of cherry-picked Lodash methods it depends on.
But it's better to use Standalone version, than include full Lodash just as dependency, if you don't need Lodash.
#### Using npm:
npm i --save deepdash
In Node.js:
js
// load Lodash if you need it
const _ = require('lodash');
//mixin all the methods into Lodash object
require('deepdash')(_);
// or cherry-pick method you only need and mix it into lodash
require('deepdash/addFilterDeep')(_);
// or cherry-pick method separately if you don't want to mutate Lodash instance
const filterDeep = require('deepdash/getFilterDeep')(_);
// If you don't need Lodash - there is standalone version
const deepdash = require('deepdash/standalone'); // full
const filterDeep = require('deepdash/filterDeep'); // or separate standalone methods
`There is also deepdash as ES6 module
npm i --save deepdash-es
js
import lodash from 'lodash-es';
import deepdash from 'deepdash-es';
const _ = deepdash(lodash);
`
in the ES package there are same cherry-pick and/or standalone methods as in the main package.
js
import filterDeep from 'deepdash-es/filterDeep';
`
or
js
import { filterDeep } from 'deepdash-es/standalone';
`
or
js
import _ from 'lodash-es';
import getFilterDeep from 'deepdash-es/getFilterDeep';
const filterDeep = getFilterDeep(_);
`
or
js
import _ from 'lodash-es';
import addFilterDeep from 'deepdash-es/addFilterDeep';
addFilterDeep(_);// --> _.filterDeep
`Demo
Example react+redux app with nested comments filtered by Deepdash.(source is here)Methods
$3
โบ iterate over all the children and sub-children ๐ see docs
expand example
let children = [/ expand to see /];
js
let children = [
{
description: 'description for node 1',
comment: 'comment for node 1',
note: 'note for node 1',
name: 'node 1',
bad: false,
children: [
{
description: 'description for node 1.1',
comment: 'comment for node 1.1',
note: 'note for node 1.1',
name: 'node 1.1',
bad: false,
},
{
description: 'description for node 1.2',
comment: 'comment for node 1.2',
note: 'note for node 1.2',
name: 'node 1.2',
good: true,
},
{
description: 'description for node 1.3',
comment: 'comment for node 1.3',
note: 'note for node 1.3',
name: 'node 1.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 2',
comment: 'comment for node 2',
note: 'note for node 2',
name: 'node 2',
good: true,
children: [
{
description: 'description for node 2.1',
comment: 'comment for node 2.1',
note: 'note for node 2.1',
name: 'node 2.1',
bad: false,
},
{
description: 'description for node 2.2',
comment: 'comment for node 2.2',
note: 'note for node 2.2',
name: 'node 2.2',
good: true,
},
{
description: 'description for node 2.3',
comment: 'comment for node 2.3',
note: 'note for node 2.3',
name: 'node 2.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 3',
comment: 'comment for node 3',
note: 'note for node 3',
name: 'node 3',
bad: true,
good: false,
children: [
{
description: 'description for node 3.1',
comment: 'comment for node 3.1',
note: 'note for node 3.1',
name: 'node 3.1',
bad: false,
},
{
description: 'description for node 3.2',
comment: 'comment for node 3.2',
note: 'note for node 3.2',
name: 'node 3.2',
good: true,
},
{
description: 'description for node 3.3',
comment: 'comment for node 3.3',
note: 'note for node 3.3',
name: 'node 3.3',
bad: true,
good: false,
},
],
},
];
`
js
function displayField(val, key, parent, context) {
if (_.isArray(parent)) {
key = '[' + key + ']';
}
console.log(
_.repeat(' ', context.depth) +
'โ ' +
key +
': ' +
(_.isArray(val)
? '[' + val.length + ']'
: _.isObject(val)
? '{' + (val.name || '') + '}'
: val)
);
} console.log('\n = Iterate over tree (each child object) = \n');
_.eachDeep(children, displayField, { childrenPath: 'children' });
console.log('\n = Iterate over object (each field) = \n');
_.eachDeep(children, displayField);
`
Console:
= Iterate over tree (each child object) =โ [0]: {node 1}
โ [0]: {node 1.1}
โ [1]: {node 1.2}
โ [2]: {node 1.3}
โ [1]: {node 2}
โ [0]: {node 2.1}
โ [1]: {node 2.2}
โ [2]: {node 2.3}
โ [2]: {node 3}
โ [0]: {node 3.1}
โ [1]: {node 3.2}
โ [2]: {node 3.3}
= Iterate over object (each field) =
โ [0]: {node 1}
โ description: description for node 1
โ comment: comment for node 1
โ note: note for node 1
โ name: node 1
โ bad: false
โ children: [3]
โ [0]: {node 1.1}
โ description: description for node 1.1
โ comment: comment for node 1.1
โ note: note for node 1.1
โ name: node 1.1
โ bad: false
โ [1]: {node 1.2}
โ description: description for node 1.2
โ comment: comment for node 1.2
โ note: note for node 1.2
โ name: node 1.2
โ good: true
โ [2]: {node 1.3}
โ description: description for node 1.3
โ comment: comment for node 1.3
โ note: note for node 1.3
โ name: node 1.3
โ bad: true
โ good: false
โ [1]: {node 2}
โ description: description for node 2
โ comment: comment for node 2
โ note: note for node 2
โ name: node 2
โ good: true
โ children: [3]
โ [0]: {node 2.1}
โ description: description for node 2.1
โ comment: comment for node 2.1
โ note: note for node 2.1
โ name: node 2.1
โ bad: false
โ [1]: {node 2.2}
โ description: description for node 2.2
โ comment: comment for node 2.2
โ note: note for node 2.2
โ name: node 2.2
โ good: true
โ [2]: {node 2.3}
โ description: description for node 2.3
โ comment: comment for node 2.3
โ note: note for node 2.3
โ name: node 2.3
โ bad: true
โ good: false
โ [2]: {node 3}
โ description: description for node 3
โ comment: comment for node 3
โ note: note for node 3
โ name: node 3
โ bad: true
โ good: false
โ children: [3]
โ [0]: {node 3.1}
โ description: description for node 3.1
โ comment: comment for node 3.1
โ note: note for node 3.1
โ name: node 3.1
โ bad: false
โ [1]: {node 3.2}
โ description: description for node 3.2
โ comment: comment for node 3.2
โ note: note for node 3.2
โ name: node 3.2
โ good: true
โ [2]: {node 3.3}
โ description: description for node 3.3
โ comment: comment for node 3.3
โ note: note for node 3.3
โ name: node 3.3
โ bad: true
โ good: false
$3
โบ deep filter object ๐ see docs
expand example
let children = [/ expand to see /];
js
let children = [
{
description: 'description for node 1',
comment: 'comment for node 1',
note: 'note for node 1',
name: 'node 1',
bad: false,
children: [
{
description: 'description for node 1.1',
comment: 'comment for node 1.1',
note: 'note for node 1.1',
name: 'node 1.1',
bad: false,
},
{
description: 'description for node 1.2',
comment: 'comment for node 1.2',
note: 'note for node 1.2',
name: 'node 1.2',
good: true,
},
{
description: 'description for node 1.3',
comment: 'comment for node 1.3',
note: 'note for node 1.3',
name: 'node 1.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 2',
comment: 'comment for node 2',
note: 'note for node 2',
name: 'node 2',
good: true,
children: [
{
description: 'description for node 2.1',
comment: 'comment for node 2.1',
note: 'note for node 2.1',
name: 'node 2.1',
bad: false,
},
{
description: 'description for node 2.2',
comment: 'comment for node 2.2',
note: 'note for node 2.2',
name: 'node 2.2',
good: true,
},
{
description: 'description for node 2.3',
comment: 'comment for node 2.3',
note: 'note for node 2.3',
name: 'node 2.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 3',
comment: 'comment for node 3',
note: 'note for node 3',
name: 'node 3',
bad: true,
good: false,
children: [
{
description: 'description for node 3.1',
comment: 'comment for node 3.1',
note: 'note for node 3.1',
name: 'node 3.1',
bad: false,
},
{
description: 'description for node 3.2',
comment: 'comment for node 3.2',
note: 'note for node 3.2',
name: 'node 3.2',
good: true,
},
{
description: 'description for node 3.3',
comment: 'comment for node 3.3',
note: 'note for node 3.3',
name: 'node 3.3',
bad: true,
good: false,
},
],
},
];
`
js
console.log('\n = Filter tree (good children) = \n'); console.log(
_.filterDeep(children, 'good', { childrenPath: 'children' })
);
console.log('\n = Filter object (names of good children) = \n');
console.log(
_.filterDeep(children, (val, key, parent) => {
if (key == 'name' && parent.good) return true;
})
);
`
Console:
= Filter tree (good children) =[
{
"description": "description for node 1",
"comment": "comment for node 1",
"note": "note for node 1",
"name": "node 1",
"bad": false,
"children": [
{
"description": "description for node 1.2",
"comment": "comment for node 1.2",
"note": "note for node 1.2",
"name": "node 1.2",
"good": true
}
]
},
{
"description": "description for node 2",
"comment": "comment for node 2",
"note": "note for node 2",
"name": "node 2",
"good": true,
"children": [
{
"description": "description for node 2.2",
"comment": "comment for node 2.2",
"note": "note for node 2.2",
"name": "node 2.2",
"good": true
}
]
},
{
"description": "description for node 3",
"comment": "comment for node 3",
"note": "note for node 3",
"name": "node 3",
"bad": true,
"good": false,
"children": [
{
"description": "description for node 3.2",
"comment": "comment for node 3.2",
"note": "note for node 3.2",
"name": "node 3.2",
"good": true
}
]
}
]
= Filter object (names of good children) =
[
{
"children": [
{
"name": "node 1.2"
}
]
},
{
"name": "node 2",
"children": [
{
"name": "node 2.2"
}
]
},
{
"children": [
{
"name": "node 3.2"
}
]
}
]
$3
โบ find first matching deep meta-value ๐ see docs
example a bit later
let children = [/ expand to see /];
js
// next time
`
js
// sorry
`
Console:
โค๏ธ
Try it yourself (no yet) โบโบโบ
$3
โบ find first matching deep value ๐ see docs
example a bit later
let children = [/ expand to see /];
js
// next time
`
js
// sorry
`
Console:
โค๏ธ
Try it yourself (no yet) โบโบโบ
$3
โบ find the path of the first matching deep value ๐ see docs
example a bit later
let children = [/ expand to see /];
js
// next time
`
js
// sorry
`
Console:
โค๏ธ
Try it yourself (no yet) โบโบโบ
$3
โบ get array of values processed by iteratee. ๐ see docs
expand example
js
let res = _.mapDeep(
{ hello: { from: { the: 'deep world', and: 'deepdash' } } },
(v) => v.toUpperCase(),
{ leavesOnly: true }
);
// res -> ['DEEP WORLD','DEEPDASH']
`
Try it yourself (no yet) โบโบโบ
$3
โบ get the object with same structure, but transformed values. ๐ see docs
expand example
js
let res = _.mapValuesDeep(
{ hello: { from: { the: 'deep world' } } },
(v) => v.toUpperCase(),
{ leavesOnly: true }
);
// res -> { hello: { from: { the: 'DEEP WORLD' } } }
`
$3
โบ get the object with same values, but transformed keys. ๐ see docs
expand example
js
let res = _.mapKeysDeep(
{ hello: { from: { the: 'deep world' } } },
(v, k) => k.toUpperCase()
);
// res -> { HELLO: { FROM: { THE: 'deep world' } } }
`
Try it yourself (no yet) โบโบโบ
$3
โบ like reduce, but deep ๐ see docs
expand example
js
let max = _.reduceDeep({ a: 2, b: 3, c: { d: 6, e: [1, 5, 8] } },
(acc, value, key, parent, ctx) => {
if (typeof value == 'number' && (typeof acc != 'number' || value > acc))
return value;
return undefined;
}
);
// max == 8
`
$3
โบ returns true if some matching deep value found ๐ see docs
example a bit later
let children = [/ expand to see /];
js
// next time
`
js
// sorry
`
Console:
โค๏ธ
Try it yourself (no yet) โบโบโบ
$3
โบ pick values by paths specified by endings or regexes ๐ see docs
expand example
let children = [/ expand to see /];
js
let children = [
{
description: 'description for node 1',
comment: 'comment for node 1',
note: 'note for node 1',
name: 'node 1',
bad: false,
children: [
{
description: 'description for node 1.1',
comment: 'comment for node 1.1',
note: 'note for node 1.1',
name: 'node 1.1',
bad: false,
},
{
description: 'description for node 1.2',
comment: 'comment for node 1.2',
note: 'note for node 1.2',
name: 'node 1.2',
good: true,
},
{
description: 'description for node 1.3',
comment: 'comment for node 1.3',
note: 'note for node 1.3',
name: 'node 1.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 2',
comment: 'comment for node 2',
note: 'note for node 2',
name: 'node 2',
good: true,
children: [
{
description: 'description for node 2.1',
comment: 'comment for node 2.1',
note: 'note for node 2.1',
name: 'node 2.1',
bad: false,
},
{
description: 'description for node 2.2',
comment: 'comment for node 2.2',
note: 'note for node 2.2',
name: 'node 2.2',
good: true,
},
{
description: 'description for node 2.3',
comment: 'comment for node 2.3',
note: 'note for node 2.3',
name: 'node 2.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 3',
comment: 'comment for node 3',
note: 'note for node 3',
name: 'node 3',
bad: true,
good: false,
children: [
{
description: 'description for node 3.1',
comment: 'comment for node 3.1',
note: 'note for node 3.1',
name: 'node 3.1',
bad: false,
},
{
description: 'description for node 3.2',
comment: 'comment for node 3.2',
note: 'note for node 3.2',
name: 'node 3.2',
good: true,
},
{
description: 'description for node 3.3',
comment: 'comment for node 3.3',
note: 'note for node 3.3',
name: 'node 3.3',
bad: true,
good: false,
},
],
},
];
`
js
console.log('\n = Pick name and description only = \n'); console.log(
_.pickDeep(children, ['name', 'description'])
);
`
Console:
= Pick name and description only =[
{
"description": "description for node 1",
"name": "node 1",
"children": [
{
"description": "description for node 1.1",
"name": "node 1.1"
},
{
"description": "description for node 1.2",
"name": "node 1.2"
},
{
"description": "description for node 1.3",
"name": "node 1.3"
}
]
},
{
"description": "description for node 2",
"name": "node 2",
"children": [
{
"description": "description for node 2.1",
"name": "node 2.1"
},
{
"description": "description for node 2.2",
"name": "node 2.2"
},
{
"description": "description for node 2.3",
"name": "node 2.3"
}
]
},
{
"description": "description for node 3",
"name": "node 3",
"children": [
{
"description": "description for node 3.1",
"name": "node 3.1"
},
{
"description": "description for node 3.2",
"name": "node 3.2"
},
{
"description": "description for node 3.3",
"name": "node 3.3"
}
]
}
]
$3
โบ get object without paths specified by endings or regexes ๐ see docs
expand example
let children = [/ expand to see /];
js
let children = [
{
description: 'description for node 1',
comment: 'comment for node 1',
note: 'note for node 1',
name: 'node 1',
bad: false,
children: [
{
description: 'description for node 1.1',
comment: 'comment for node 1.1',
note: 'note for node 1.1',
name: 'node 1.1',
bad: false,
},
{
description: 'description for node 1.2',
comment: 'comment for node 1.2',
note: 'note for node 1.2',
name: 'node 1.2',
good: true,
},
{
description: 'description for node 1.3',
comment: 'comment for node 1.3',
note: 'note for node 1.3',
name: 'node 1.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 2',
comment: 'comment for node 2',
note: 'note for node 2',
name: 'node 2',
good: true,
children: [
{
description: 'description for node 2.1',
comment: 'comment for node 2.1',
note: 'note for node 2.1',
name: 'node 2.1',
bad: false,
},
{
description: 'description for node 2.2',
comment: 'comment for node 2.2',
note: 'note for node 2.2',
name: 'node 2.2',
good: true,
},
{
description: 'description for node 2.3',
comment: 'comment for node 2.3',
note: 'note for node 2.3',
name: 'node 2.3',
bad: true,
good: false,
},
],
},
{
description: 'description for node 3',
comment: 'comment for node 3',
note: 'note for node 3',
name: 'node 3',
bad: true,
good: false,
children: [
{
description: 'description for node 3.1',
comment: 'comment for node 3.1',
note: 'note for node 3.1',
name: 'node 3.1',
bad: false,
},
{
description: 'description for node 3.2',
comment: 'comment for node 3.2',
note: 'note for node 3.2',
name: 'node 3.2',
good: true,
},
{
description: 'description for node 3.3',
comment: 'comment for node 3.3',
note: 'note for node 3.3',
name: 'node 3.3',
bad: true,
good: false,
},
],
},
];
`
js
console.log('\n = Omit paths not ending with "e" = \n'); console.log(
_.omitDeep(children, /[^e]$/i, { onMatch: { skipChildren: false } }),
);
`
Console:
= Omit paths not ending with "e" =[
{
"note": "note for node 1",
"name": "node 1",
"children": [
{
"note": "note for node 1.1",
"name": "node 1.1"
},
{
"note": "note for node 1.2",
"name": "node 1.2"
},
{
"note": "note for node 1.3",
"name": "node 1.3"
}
]
},
{
"note": "note for node 2",
"name": "node 2",
"children": [
{
"note": "note for node 2.1",
"name": "node 2.1"
},
{
"note": "note for node 2.2",
"name": "node 2.2"
},
{
"note": "note for node 2.3",
"name": "node 2.3"
}
]
},
{
"note": "note for node 3",
"name": "node 3",
"children": [
{
"note": "note for node 3.1",
"name": "node 3.1"
},
{
"note": "note for node 3.2",
"name": "node 3.2"
},
{
"note": "note for node 3.3",
"name": "node 3.3"
}
]
}
]
$3
โบ get an object with all the paths as keys and corresponding values ๐ see docs
expand example
js
let index = _.index(
{
a: {
b: {
c: [1, 2, 3],
'hello world': {},
},
},
},
{ leavesOnly: true }
);
console.log(index);
`Console:
{ 'a.b.c[0]': 1,
'a.b.c[1]': 2,
'a.b.c[2]': 3,
'a.b["hello world"]': {} }
$3
โบ get an array of paths ๐ see docs
expand example
js
let paths = _.paths(
{
a: {
b: {
c: [1, 2, 3],
'hello world': {},
},
},
},
{ leavesOnly: false }
);
console.log(paths);
`Console:
[ 'a',
'a.b',
'a.b.c',
'a.b.c[0]',
'a.b.c[1]',
'a.b.c[2]',
'a.b["hello world"]' ]
$3
โบ condense sparse array ๐ see docs
expand example
js
let arr = ['a', 'b', 'c', 'd', 'e'];
delete arr[1];
console.log(arr);
delete arr[3];
console.log(arr);
_.condense(arr);
console.log(arr);
`Console:
[ 'a', <1 empty item>, 'c', 'd', 'e' ]
[ 'a', <1 empty item>, 'c', <1 empty item>, 'e' ]
[ 'a', 'c', 'e' ]
$3
โบ condense all the nested arrays ๐ see docs
expand example
js
let obj = { arr: ['a', 'b', { c: [1, , 2, , 3] }, 'd', 'e'] };
delete obj.arr[1];
delete obj.arr[3];
_.condenseDeep(obj);
console.log(obj);
`Console:
{ arr: [ 'a', { c: [ 1, 2, 3 ] }, 'e' ] }
$3
โบ like a but returns false for empty array slots ๐ see docs
expand example
`js
var obj = [, { a: [, 'b'] }];
console.log(_.exists(obj, 0)); // false
console.log(_.exists(obj, 1)); // true
console.log(_.exists(obj, '[1].a[0]')); // false
console.log(_.exists(obj, '[1].a[1]')); // true
`
$3
โบ convert an array to string path (opposite to _.toPath) ๐ see docs
expand example
js
console.log(_.pathToString(['a', 'b', 'c', 'defg', 0, '1', 2.3]
,'prefix1', 'prefix2', '[3]'));
// prefix1.prefix2[3].a.b.c.defg[0][1]["2.3"]
console.log(_.pathToString(['"', '"', '"']));
// ["\\""]["\\""]["\\""]
console.log(_.pathToString('it.s.a.string'));
// it.s.a.string
``$3
Contributors โจ
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!