| 1 | # lsr
|
| 2 |
|
| 3 | Recursive readdir (`ls -R`)
|
| 4 |
|
| 5 | [](https://travis-ci.org/ForbesLindesay/lsr)
|
| 6 | [](https://david-dm.org/ForbesLindesay/lsr)
|
| 7 | [](https://www.npmjs.com/package/lsr)
|
| 8 |
|
| 9 | ## Installation
|
| 10 |
|
| 11 | npm install lsr
|
| 12 |
|
| 13 | ## Usage
|
| 14 |
|
| 15 | ```js
|
| 16 | const {lsrSync, lsrAsync, lsrStream} = require('lsrc');
|
| 17 | // Synchronous
|
| 18 | console.dir(lsrSync(__dirname))
|
| 19 |
|
| 20 | // Promise
|
| 21 | lsrAsync(__dirname).then(function (res) {
|
| 22 | console.dir(res)
|
| 23 | })
|
| 24 |
|
| 25 | // Stream
|
| 26 | lsrStream(__dirname).pipe(getPath()).pipe(process.stdout)
|
| 27 | ```
|
| 28 |
|
| 29 | ## API
|
| 30 |
|
| 31 | Each file system entry is represented by a [Stat](http://nodejs.org/api/fs.html#fs_class_fs_stats) object with the additional properties:
|
| 32 |
|
| 33 | - `name`: the file name (e.g. `foo.txt`)
|
| 34 | - `path`: the relative path to the file (e.g. `./subdir/foo.txt`). This is always separated by `/` regardless of platform.
|
| 35 | - `fullPath`: the full path to the file (e.g. `c:\\basedir\\foo.txt` or `/basedir/foo.txt`). This is separated by the correct path separater for the platform.
|
| 36 |
|
| 37 | ### lsrAsync(dir, options, callback)
|
| 38 |
|
| 39 | Recursively lists the files and folders and calls the callback exactly once with the error or null as the first argument and an array of file system entries as the second argument.
|
| 40 |
|
| 41 | Options:
|
| 42 |
|
| 43 | - ignoreErrors - if any stat calls result in an error, simply ignore that item
|
| 44 | - filter - a function that is called with a file sytem entry as its only argument and should return `true` to include that entry and any sub-entries in the result and `false` otherwise
|
| 45 | - filterPath - a function that is called with the `path` property of the file system entry (before the call to `fs.stat`) as its only argument and should return `true` to include that entry and any sub-entries in the result and `false` otherwise
|
| 46 |
|
| 47 | If the callback is ommitted, a promise is returned instead.
|
| 48 |
|
| 49 | ### lsrSync(dir, options)
|
| 50 |
|
| 51 | Recursively lists the files and folders and returns an array of file system entries.
|
| 52 |
|
| 53 | Options:
|
| 54 |
|
| 55 | - ignoreErrors - if any stat calls result in an error, simply ignore that item
|
| 56 | - filter - a function that is called with a file sytem entry as its only argument and should return `true` to include that entry and any sub-entries in the result and `false` otherwise
|
| 57 | - filterPath - a function that is called with the `path` property of the file system entry (before the call to `fs.stat`) as its only argument and should return `true` to include that entry and any sub-entries in the result and `false` otherwise
|
| 58 |
|
| 59 | ### lsrStream(dir, options)
|
| 60 |
|
| 61 | Recursively lists the files and folders and returns a stream of file system entries.
|
| 62 |
|
| 63 | Options:
|
| 64 |
|
| 65 | - ignoreErrors - if any stat calls result in an error, simply ignore that item
|
| 66 | - filter - a function that is called with a file sytem entry as its only argument and should return `true` to include that entry and any sub-entries in the result and `false` otherwise
|
| 67 | - filterPath - a function that is called with the `path` property of the file system entry (before the call to `fs.stat`) as its only argument and should return `true` to include that entry and any sub-entries in the result and `false` otherwise
|
| 68 | - highWaterMark - the maximum number of file system entries to buffer before it should stop calling `readdir` and `stat` while it waits for the consuming stream to catch up
|
| 69 |
|
| 70 | ## License
|
| 71 |
|
| 72 | MIT
|