Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinnn/lstat-dir
Run `fs.lstat()` for all contents in a given directory
https://github.com/shinnn/lstat-dir
async directory filesystem information lstat mode promise readdir stat
Last synced: 26 days ago
JSON representation
Run `fs.lstat()` for all contents in a given directory
- Host: GitHub
- URL: https://github.com/shinnn/lstat-dir
- Owner: shinnn
- License: isc
- Created: 2017-02-15T08:27:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-24T01:55:05.000Z (over 5 years ago)
- Last Synced: 2024-10-10T17:07:07.611Z (about 1 month ago)
- Topics: async, directory, filesystem, information, lstat, mode, promise, readdir, stat
- Language: JavaScript
- Homepage:
- Size: 142 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# lstat-dir
[](https://www.npmjs.com/package/lstat-dir)
[](https://travis-ci.com/shinnn/lstat-dir)
[](https://codecov.io/gh/shinnn/lstat-dir)
Run [`fs.promises.lstat()`](https://nodejs.org/api/fs.html#fs_fspromises_lstat_path_options) for all contents in a given directory
```javascript
const lstatDir = require('lstat-dir');
(async () => {
await lstatDir('node_modules/lstat-dir'); /*=> Map {
'/Users/example/node_modules/lstat-dir/LICENSE' => {mode: 33188, size: 1086, ...},
'/Users/example/node_modules/lstat-dir/README.md' => {mode: 33188, size: 2060, ...}
'/Users/example/node_modules/lstat-dir/index.js' => {mode: 33188, size: 124, ...}
'/Users/example/node_modules/lstat-dir/package.json' => {mode: 33188, size: 922, ...}
} */
})();
```
## Installation
[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).
```
npm install lstat-dir
```
## API
```javascript
const lstatDir = require('lstat-dir');
```
### lstatDir(*dir*, [*options*])
*dir*: `string | Buffer | URL` (directory path)
*options*: `Object` ([`readdir-sorted`](https://github.com/shinnn/readdir-sorted) options)
Return: `Promise`
The returned `Promise` is fulfilled with a [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map), whose [keys](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map/keys) are absolute paths of contents in the directory, and whose [values](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map/values) are [`fs.Stats`](https://nodejs.org/api/fs.html#fs_class_fs_stats) of contents.
```javascript
/* my-dir
├── file.txt
├── symlink => file.txt
└── tmp
└── debug.log
*/
(async () => {
const stats = await lstatDir('my-dir');
stats instanceof Map; //=> true
stats.keys(); /*=> MapIterator {
'/Users/example/my-dir/file.txt',
'/Users/example/my-dir/symlink',
'/Users/example/my-dir/tmp'
} */
stats.get('/Users/example/my-dir/file.txt').isFile(); //=> true
stats.get('/Users/example/my-dir/symlink').isSymbolicLink(); //=> true
stats.get('/Users/example/my-dir/tmp').isDirectory()(); //=> true
})();
```
Options are directly passed to the underlying [`readdir-sorted`](https://github.com/shinnn/readdir-sorted#readdirsortedpath--options) to control the order of `keys`.
```javascript
(async() => {
[...(await lstatDir('/path/dir')).keys()];
// => ['/path/dir/10.txt', '/path/dir/2.txt', '/path/dir/ä.txt', '/path/dir/z.txt']
[...(await lstatDir('/path/dir', {
locale: 'sv',
numeric: true
})).keys()];
//=> ['/path/dir/2.txt', '/path/dir/10.txt', '/path/dir/z.txt', '/path/dir/ä.txt']
})();
```
## License
[ISC License](./LICENSE) © 2017 - 2019 Shinnosuke Watanabe