make a more synchronous version possible
This commit is contained in:
parent
ec07897228
commit
dad2e70092
56
README.md
56
README.md
|
@ -24,12 +24,11 @@ Usage
|
|||
|
||||
Both Asynchronous and Synchronous versions are provided.
|
||||
|
||||
The Synchronous version still uses callbacks, so it is safe to use with other Asynchronous functions and will still work as expected.
|
||||
|
||||
var walk = require('walk'),
|
||||
fs = require('fs'),
|
||||
options,
|
||||
walker;
|
||||
var walk = require('walk')
|
||||
, fs = require('fs')
|
||||
, options
|
||||
, walker
|
||||
;
|
||||
|
||||
options = {
|
||||
followLinks: false,
|
||||
|
@ -71,6 +70,51 @@ The Synchronous version still uses callbacks, so it is safe to use with other As
|
|||
walker.on("end", function () {
|
||||
console.log("all done");
|
||||
});
|
||||
```
|
||||
### Async
|
||||
|
||||
The Synchronous version can operate without a callback if the event handlers are passed in
|
||||
|
||||
```javascript
|
||||
var walk = require('walk')
|
||||
, fs = require('fs')
|
||||
, options
|
||||
, walker
|
||||
;
|
||||
|
||||
options = {
|
||||
listeners: {
|
||||
names: function (root, nodeNamesArray) {
|
||||
nodeNames.sort(function (a, b) {
|
||||
if (a > b) return 1;
|
||||
if (a < b) return -1;
|
||||
return 0;
|
||||
});
|
||||
}
|
||||
, directories: function (root, dirStatsArray, next) {
|
||||
// dirStatsArray is an array of `stat` objects with the additional attributes
|
||||
// * type
|
||||
// * error
|
||||
// * name
|
||||
|
||||
next();
|
||||
}
|
||||
, file: function (root, fileStats, next) {
|
||||
fs.readFile(fileStats.name, function () {
|
||||
// doStuff
|
||||
next();
|
||||
});
|
||||
}
|
||||
, errors: function (root, nodeStatsArray, next) {
|
||||
next();
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
walker = walk.walkSync("/tmp", options);
|
||||
|
||||
console.log("all done");
|
||||
```
|
||||
|
||||
API
|
||||
====
|
||||
|
|
Loading…
Reference in New Issue