FileWatcher.API

Class: FileWatcher

FileWatcher

new FileWatcher()

A basic filewatcher.

Source:

• system/FileWatcher.js , lineno 20

Methods

addFile(path, callbackModfied, callbackAdded, callbackRemoved, callbackNotValid)

Add a file to watch.

Parameters:

Name	Type	Argument	Description
path	String		The filepath
callbackModfied	function		Callback if watched file is modified
callbackAdded	function	<optional>	Callback
callbackRemoved	function	<optional>	Callback if watched file has been removed
callbackNotValid	function	<optional>	Callback if path isnt valid

Source:

• system/FileWatcher.js , lineno 83

hasFile(path) → {Boolean}

Return if the watcher is currentky watching this file.

Parameters:

Name	Type	Description
path	String	= The file path

Source:

• system/FileWatcher.js , lineno 176

Returns:

Type

Boolean

removeFile(path)

Remove a file from the watcher.

Parameters:

Name	Type	Description
path	String	The file path

Source:

• system/FileWatcher.js , lineno 155

restart()

Restart the watcher if stopped.

Source:

• system/FileWatcher.js , lineno 191

stop()

Stop the watcher.

Source:

• system/FileWatcher.js , lineno 202

Generated with wicked.