blob: 3f7b835334c20efb2979740e45b904c32ad4d209 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
# @nodelib/fs.stat
> Get the status of a file with some features.
## :bulb: Highlights
Wrapper over standard methods ([`fs.lstat`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_lstat_path_callback), [`fs.stat`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_stat_path_callback)) with some features.
* :beginner: Normally follows symlinks.
* :gear: Can safely work with broken symlinks (returns information about symlink instead of generating an error).
## Install
```
$ npm install @nodelib/fs.stat
```
## Usage
```js
const fsStat = require('@nodelib/fs.stat');
fsStat.stat('path').then((stat) => {
console.log(stat); // => fs.Stats
});
```
## API
### fsStat.stat(path, [options])
Returns a [`Promise<fs.Stats>`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_class_fs_stats) for provided path.
### fsStat.statSync(path, [options])
Returns a [`fs.Stats`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_class_fs_stats) for provided path.
### fsStat.statCallback(path, [options], callback)
Returns a [`fs.Stats`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_class_fs_stats) for provided path with standard callback-style.
#### path
* Type: `string | Buffer | URL`
The `path` argument for [`fs.lstat`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_lstat_path_callback) or [`fs.stat`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_stat_path_callback) method.
#### options
* Type: `Object`
See [options](#options-1) section for more detailed information.
## Options
### throwErrorOnBrokenSymlinks
* Type: `boolean`
* Default: `true`
Throw an error or return information about symlink, when symlink is broken. When `false`, methods will be return lstat call for broken symlinks.
### followSymlinks
* Type: `boolean`
* Default: `true`
By default, the methods of this package follows symlinks. If you do not want it, set this option to `false` or use the standard method [`fs.lstat`](https://nodejs.org/dist/latest/docs/api/fs.html#fs_fs_lstat_path_callback).
### fs
* Type: `FileSystemAdapter`
* Default: `built-in FS methods`
By default, the built-in Node.js module (`fs`) is used to work with the file system. You can replace each method with your own.
```ts
interface FileSystemAdapter {
lstat?: typeof fs.lstat;
stat?: typeof fs.stat;
lstatSync?: typeof fs.lstatSync;
statSync?: typeof fs.statSync;
}
```
## Changelog
See the [Releases section of our GitHub project](https://github.com/nodelib/nodelib/releases) for changelogs for each release version.
## License
This software is released under the terms of the MIT license.
|
