Skip to content

Commit

Permalink
document follow+nodir
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Mar 28, 2024
1 parent b5d0f64 commit b1d8105
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -509,6 +509,9 @@ share the previously loaded cache.
- `nodir` Do not match directories, only files. (Note: to match
_only_ directories, put a `/` at the end of the pattern.)

Note: when `follow` and `nodir` are both set, then symbolic
links to directories are also omitted.

- `stat` Call `lstat()` on all entries, whether required or not
to determine whether it's a valid match. When used with
`withFileTypes`, this means that matches will include data such
Expand Down Expand Up @@ -539,6 +542,9 @@ share the previously loaded cache.
it is not the first item in the pattern, or none if it is the
first item in the pattern, following the same behavior as Bash.

Note: when `follow` and `nodir` are both set, then symbolic
links to directories are also omitted.

- `realpath` Set to true to call `fs.realpath` on all of the
results. In the case of an entry that cannot be resolved, the
entry is omitted. This incurs a slight performance penalty, of
Expand Down

0 comments on commit b1d8105

Please sign in to comment.