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 😉

Installation

In a browser

Load script after Lodash, then pass a lodash instance to the deepdash function:

<script src="https://cdn.jsdelivr.net/npm/lodash/lodash.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/deepdash/browser/deepdash.min.js"></script>
<script>
  deepdash(_);
  console.log(_.eachDeep); // --> new methods mixed into Lodash
</script>

If you don't use Lodash - there is a standalone version:

<script src="https://cdn.jsdelivr.net/npm/deepdash/browser/deepdash.standalone.min.js"></script>
<script>
  console.log(deepdash.eachDeep); // --> all the methods just work
</script>

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:

// 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

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.

import filterDeep from 'deepdash-es/filterDeep';

or

import { filterDeep } from 'deepdash-es/standalone';

or

import _ from 'lodash-es';
import getFilterDeep from 'deepdash-es/getFilterDeep';
const filterDeep = getFilterDeep(_);

or

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

eachDeep (forEachDeep)

› iterate over all the children and sub-children 📚 see docs

Try it yourself ›››

filterDeep

› deep filter object 📚 see docs

Try it yourself ›››

findDeep

› find first matching deep meta-value 📚 see docs

Try it yourself (no yet) ›››

findValueDeep

› find first matching deep value 📚 see docs

Try it yourself (no yet) ›››

findPathDeep

› find the path of the first matching deep value 📚 see docs

Try it yourself (no yet) ›››

mapDeep

› get array of values processed by iteratee. 📚 see docs

Try it yourself (no yet) ›››

mapValuesDeep

› get the object with same structure, but transformed values. 📚 see docs

Try it yourself ›››

mapKeysDeep

› get the object with same values, but transformed keys. 📚 see docs

Try it yourself (no yet) ›››

reduceDeep

› like reduce, but deep 📚 see docs

Try it yourself ›››

someDeep

› returns true if some matching deep value found 📚 see docs

Try it yourself (no yet) ›››

pickDeep

› pick values by paths specified by endings or regexes 📚 see docs

Try it yourself ›››

omitDeep

› get object without paths specified by endings or regexes 📚 see docs

Try it yourself ›››

index

› get an object with all the paths as keys and corresponding values 📚 see docs

Try it yourself ›››

paths (keysDeep)

› get an array of paths 📚 see docs

Try it yourself ›››

condense

› condense sparse array 📚 see docs

Try it yourself ›››

condenseDeep

› condense all the nested arrays 📚 see docs

Try it yourself ›››

exists

› like a _.has but returns false for empty array slots 📚 see docs

Try it yourself ›››

pathToString

› convert an array to string path (opposite to _.toPath) 📚 see docs

Try it yourself ›››

See full docs for details.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Raz Sinay 💻 📓 🤔	Florent 🐛 📓	JoeSchr 🤔 📓	Matt Black 🤔	Lukas Siemon 🤔 📓 💻 📢 ⚠️	crapthings 🤔	Corrado Masciullo 🐛 🤔
Jed Richards 🚇	Kolja Zuelsdorf 🐛 📓 💡	Noval Agung Prayogo 💬	Nathan Tomsic 🤔	madflow 💬	Matthew Kirkley 🐛 🤔	Torma Gábor 🐛 🤔 📓
Andreas Richter 🐛 📓	James 🐛 💻 📖 📓	rxliuli 🐛 💻 📖	TeleMediaCC 🐛	Nicolas Coutin 💵 📓	barrct 🐛 📖	casamia918 🐛 💻 📖
ferreirix 🤔	John Camden 🐛	Joshua 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!