arg/scriptcraft
Archived
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update based on changes to watchDir()

Browse source
This commit is contained in:
walterhiggins 2014-08-23 13:40:50 +01:00
parent e485f11f6f
commit 519f20491c
1 changed files with 42 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/API-Reference.md
View file

@ -232,7 +232,9 @@ Walter Higgins
* [utils.find() function](#utilsfind-function) * [utils.find() function](#utilsfind-function)
* [utils.serverAddress() function](#utilsserveraddress-function) * [utils.serverAddress() function](#utilsserveraddress-function)
* [utils.watchFile() function](#utilswatchfile-function) * [utils.watchFile() function](#utilswatchfile-function)
* [utils.watchDir() function](#utilswatchdir-function)
* [utils.unwatchFile() function](#utilsunwatchfile-function) * [utils.unwatchFile() function](#utilsunwatchfile-function)
* [utils.unwatchDir() function](#utilsunwatchdir-function)
* [utils.array() function](#utilsarray-function) * [utils.array() function](#utilsarray-function)
* [Drone Plugin](#drone-plugin) * [Drone Plugin](#drone-plugin)
* [Constructing a Drone Object](#constructing-a-drone-object) * [Constructing a Drone Object](#constructing-a-drone-object)
@ -2865,6 +2867,28 @@ utils.watchFile( 'test.txt', function( file ) {
console.log( file + ' has changed'); console.log( file + ' has changed');
}); });
``` ```
### utils.watchDir() function
Watches for changes to the given directory and calls the function provided
when the directory changes. It works by calling watchFile/watchDir for each
file/subdirectory.
#### Parameters
* Dir - the file to watch (can be a file or directory)
* Callback - The callback to invoke when the directory has changed.
The callback takes the changed file as a parameter.
For each change inside the directory the callback will also
be called.
#### Example
```javascript
var utils = require('utils');
utils.watchDir( 'players/_ial', function( dir ) {
console.log( dir + ' has changed');
});
```
### utils.unwatchFile() function ### utils.unwatchFile() function
Removes a file from the watch list. Removes a file from the watch list.
@ -2875,6 +2899,22 @@ var utils = require('utils');
utils.unwatchFile( 'test.txt'); utils.unwatchFile( 'test.txt');
``` ```
### utils.unwatchDir() function
Removes a directory from the watch list and all files inside the directory
are also "unwatched"
#### Example
```javascript
var utils = require('utils');
utils.unwatchDir ('players/_ial');
```
Would cause also
```javascript
utils.unwatchFile (file);
```
for each file inside directory (and unwatchDir for each directory inside it)
### utils.array() function ### utils.array() function
Converts Java collection objects to type Javascript array so they can avail of Converts Java collection objects to type Javascript array so they can avail of