Skip to content

Commit

Permalink
docs: clarification for followSymbolicLinks option
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmlnc committed Jun 27, 2021
1 parent 190e6bf commit 1a28354
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,9 @@ fg.sync('**', { onlyFiles: false, cwd: 'dir', deep: 2 }); // ['one', 'one/two']
* Type: `boolean`
* Default: `true`

Indicates whether to traverse descendants of symbolic link directories.
Indicates whether to traverse descendants of symbolic link directories when expanding `**` patterns.

> :book: Note that this option does not affect the base directory of the pattern. For example, if `./a` is a symlink to directory `./b` and you specified `['./a**', './b/**']` patterns, then directory `./a` will still be read.
> :book: If the [`stats`](#stats) option is specified, the information about the symbolic link (`fs.lstat`) will be replaced with information about the entry (`fs.stat`) behind it.
Expand Down

0 comments on commit 1a28354

Please sign in to comment.