Skip to main content

Interface: HMROptions

@sapphire/plugin-hmr.HMROptions

Hierarchy​

  • WatchOptions

    ↳ HMROptions

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​

WatchOptions.alwaysStat

Defined in​

node_modules/chokidar/types/index.d.ts:130

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​

WatchOptions.atomic

Defined in​

node_modules/chokidar/types/index.d.ts:162

awaitWriteFinish​

• Optional awaitWriteFinish: boolean | AwaitWriteFinishOptions

can be set to an object in order to adjust timing params:

Inherited from​

WatchOptions.awaitWriteFinish

Defined in​

node_modules/chokidar/types/index.d.ts:167

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​

WatchOptions.binaryInterval

Defined in​

node_modules/chokidar/types/index.d.ts:146

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​

WatchOptions.cwd

Defined in​

node_modules/chokidar/types/index.d.ts:101

depth​

• Optional depth: number

If set, limits how many levels of subdirectories will be traversed.

Inherited from​

WatchOptions.depth

Defined in​

node_modules/chokidar/types/index.d.ts:135

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​

WatchOptions.disableGlobbing

Defined in​

node_modules/chokidar/types/index.d.ts:107

enabled​

• Optional enabled: boolean

Defined in​

projects/plugins/packages/hmr/src/lib/hmr.ts:6

• 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​

WatchOptions.followSymlinks

Defined in​

node_modules/chokidar/types/index.d.ts:95

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​

WatchOptions.ignoreInitial

Defined in​

node_modules/chokidar/types/index.d.ts:89

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​

WatchOptions.ignorePermissionErrors

Defined in​

node_modules/chokidar/types/index.d.ts:153

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​

WatchOptions.ignored

Defined in​

node_modules/chokidar/types/index.d.ts:83

interval​

• Optional interval: number

Interval of file system polling.

Inherited from​

WatchOptions.interval

Defined in​

node_modules/chokidar/types/index.d.ts:140

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​

WatchOptions.persistent

Defined in​

node_modules/chokidar/types/index.d.ts:74

silent​

• Optional silent: boolean

Defined in​

projects/plugins/packages/hmr/src/lib/hmr.ts:7

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​

WatchOptions.useFsEvents

Defined in​

node_modules/chokidar/types/index.d.ts:123

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​

WatchOptions.usePolling

Defined in​

node_modules/chokidar/types/index.d.ts:116