true
if useFsEvents
and usePolling
are false
. Automatically filters out artifacts
that occur when using editors that use "atomic writes" instead of writing directly to the
source file. If a file is re-added within 100 ms of being deleted, Chokidar emits a change
event rather than unlink
then add
. If the default of 100 ms does not work well for you,
you can override it by setting atomic
to a custom value, in milliseconds.
can be set to an object in order to adjust timing params:
Interval of file system polling for binary files. ([see list of binary extensions](https://gi thub.com/sindresorhus/binary-extensions/blob/master/binary-extensions.json))
The base directory from which watch paths
are to be derived. Paths emitted with events will
be relative to this.
If set, limits how many levels of subdirectories will be traversed.
If set to true then the strings passed to .watch() and .add() are treated as literal path names, even if they look like globs.
When false
, only the symlinks themselves will be watched for changes instead of following
the link references and bubbling events through the link's path.
If set to false
then add
/addDir
events are also emitted for matching paths while
instantiating the watching as chokidar discovers these file paths (before the ready
event).
Indicates whether to watch files that don't have read permissions if possible. If watching
fails due to EPERM
or EACCES
with this set to true
, the errors will be suppressed
silently.
(anymatch-compatible definition) Defines files/paths to
be ignored. The whole relative or absolute path is tested, not just filename. If a function
with two arguments is provided, it gets called twice per path - once with a single argument
(the path), second time with two arguments (the path and the
fs.Stats
object of that path).
Interval of file system polling.
Indicates whether the process should continue to run as long as files are being watched. If
set to false
when using fsevents
to watch, no more events will be emitted after ready
,
even if the process continues to run.
Whether to use the fsevents
watching interface if available. When set to true
explicitly
and fsevents
is available this supersedes the usePolling
setting. When set to false
on
OS X, usePolling: true
becomes the default.
Whether to use fs.watchFile (backed by polling), or fs.watch. If polling leads to high CPU
utilization, consider setting this to false
. It is typically necessary to set this to
true
to successfully watch files over a network, and it may be necessary to successfully
watch files in other non-standard situations. Setting to true
explicitly on OS X overrides
the useFsEvents
default.
If relying upon the
fs.Stats
object that may get passed withadd
,addDir
, andchange
events, set this totrue
to ensure it is provided even in cases where it wasn't already available from the underlying watch events.