Confusing description of traverseAll default value

[l1bbcsg]

Package version: 6.0.0

The README reads:

• traverseAll <Boolean> default: true
  • traverse all subdirectories, regardless of filter option. (When set to true, traverseAll produces similar behavior to the default behavior prior to v4.0.0. The current default of traverseAll: false is equivalent to the old noRecurseOnFailedFilter: true).

First, it says it's true by default.

Then it says "The current default of traverseAll: false" implicating it's false by default.

In the code it is in fact undefined, which is equivalent to false in this case.

If the parameter is not present, klaw-sync behaves as if it was false.

What is the intended default value of this parameter, true or false?
true seems more reasonable to me, but regardless, I believe default value should be indicated clearly in the docs and correspond to the actual behavior.

I also find it confusing that sister module node-klaw does not have this option at all.

[manidlou]

@l1bbcsg I agree the docs is not clear about traverseAll option. The default value for traverseAll is true. I will update the docs. Also, we figured this is a good approach to handle reading directories recursively while supporting filter option.

For node-klaw, we still need to so something about it! there are ongoing discussions on node-klaw repo.

jprichardson/node-klaw#11
jprichardson/node-klaw#17

[manidlou]

Closed via bc081f0

[l1bbcsg]

The actual default is still false though. See the linked line of code, the parameter is not set and therefore is undefined which then casts to false.