search

YuriGor / deepdash

eachDeep, filterDeep, findDeep, someDeep, omitDeep, pickDeep, keysDeep etc.. Tree traversal library written in Underscore/Lodash fashion
https://deepdash.io/
MIT License
272 stars 12 forks source link

Bug in documentation _.findDeep* #144

Open alexNecroJack opened 1 year ago

alexNecroJack commented 1 year ago

While reading the documentation I see:

_.findDeep( obj, predicate, options={
    checkCircular: false,
    leavesOnly: childrenPath →→ !== ←← undefined,
    ...

While checking the code, I see:

    options = _.merge(
      {
        checkCircular: false,
        leavesOnly: options.childrenPath →→ === ←← undefined, 
        pathFormat: 'string',
      },
      options
    );

(Arrows → ← added for clarity)