weapp-vite / WatchOptions
Interface: WatchOptions
Extends
WatchOptions
Properties
alwaysStat?
optional
alwaysStat:boolean
If relying upon the fs.Stats
object that may get passed with add
, addDir
, and change
events, set this to true
to ensure it is provided even in cases where it wasn't already available from the underlying watch events.
Inherited from
ChokidarWatchOptions.alwaysStat
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:134
atomic?
optional
atomic:number
|boolean
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.
Inherited from
ChokidarWatchOptions.atomic
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:166
awaitWriteFinish?
optional
awaitWriteFinish:boolean
|AwaitWriteFinishOptions
can be set to an object in order to adjust timing params:
Inherited from
ChokidarWatchOptions.awaitWriteFinish
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:171
binaryInterval?
optional
binaryInterval:number
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))
Inherited from
ChokidarWatchOptions.binaryInterval
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:150
cwd?
optional
cwd:string
The base directory from which watch paths
are to be derived. Paths emitted with events will be relative to this.
Inherited from
ChokidarWatchOptions.cwd
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:105
depth?
optional
depth:number
If set, limits how many levels of subdirectories will be traversed.
Inherited from
ChokidarWatchOptions.depth
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:139
disableGlobbing?
optional
disableGlobbing:boolean
If set to true then the strings passed to .watch() and .add() are treated as literal path names, even if they look like globs. Default: false.
Inherited from
ChokidarWatchOptions.disableGlobbing
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:111
followSymlinks?
optional
followSymlinks:boolean
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.
Inherited from
ChokidarWatchOptions.followSymlinks
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:99
ignored?
optional
ignored:AnymatchMatcher
(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).
Inherited from
ChokidarWatchOptions.ignored
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:87
ignoreInitial?
optional
ignoreInitial:boolean
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).
Inherited from
ChokidarWatchOptions.ignoreInitial
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:93
ignorePermissionErrors?
optional
ignorePermissionErrors:boolean
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.
Inherited from
ChokidarWatchOptions.ignorePermissionErrors
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:157
interval?
optional
interval:number
Interval of file system polling.
Inherited from
ChokidarWatchOptions.interval
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:144
paths?
optional
paths: readonlystring
[]
Defined in
packages/weapp-vite/src/types.ts:63
persistent?
optional
persistent:boolean
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.
Inherited from
ChokidarWatchOptions.persistent
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:78
useFsEvents?
optional
useFsEvents:boolean
Whether to use the fsevents
watching interface if available. When set to true
explicitly and fsevents
is available this supercedes the usePolling
setting. When set to false
on OS X, usePolling: true
becomes the default.
Inherited from
ChokidarWatchOptions.useFsEvents
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:127
usePolling?
optional
usePolling:boolean
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.
Inherited from
ChokidarWatchOptions.usePolling
Defined in
node_modules/.pnpm/chokidar@3.6.0/node_modules/chokidar/types/index.d.ts:120