Get the status of a file with some features.
Wrapper around standard method fs.lstat
and fs.stat
with some features.
npm install @nodelib/fs.stat
import * as fsStat from '@nodelib/fs.stat'; fsStat.stat('path', (error, stats) => { /* … */ });
Returns an instance of fs.Stats
class for provided path with standard callback-style.
fsStat.stat('path', (error, stats) => { /* … */ }); fsStat.stat('path', {}, (error, stats) => { /* … */ }); fsStat.stat('path', new fsStat.Settings(), (error, stats) => { /* … */ });
Returns an instance of fs.Stats
class for provided path.
const stats = fsStat.stat('path'); const stats = fsStat.stat('path', {}); const stats = fsStat.stat('path', new fsStat.Settings());
true
string | Buffer | URL
A path to a file. If a URL is provided, it must use the file:
protocol.
false
Options | Settings
Settings
classAn Options
object or an instance of Settings
class.
:book: When you pass a plain object, an instance of the
Settings
class will be created automatically. If you plan to call the method frequently, use a pre-created instance of theSettings
class.
A class of full settings of the package.
const settings = new fsStat.Settings({ followSymbolicLink: false }); const stats = fsStat.stat('path', settings);
followSymbolicLink
boolean
true
Follow symbolic link or not. Call fs.stat
on symbolic link if true
.
markSymbolicLink
boolean
false
Mark symbolic link by setting the return value of isSymbolicLink
function to always true
(even after fs.stat
).
:book: Can be used if you want to know what is hidden behind a symbolic link, but still continue to know that it is a symbolic link.
throwErrorOnBrokenSymbolicLink
boolean
true
Throw an error when symbolic link is broken if true
or safely return lstat
call if false
.
fs
FileSystemAdapter
By default, the built-in Node.js module (fs
) is used to work with the file system. You can replace any method with your own.
interface FileSystemAdapter { lstat?: typeof fs.lstat; stat?: typeof fs.stat; lstatSync?: typeof fs.lstatSync; statSync?: typeof fs.statSync; } const settings = new fsStat.Settings({ fs: { lstat: fakeLstat } });
See the Releases section of our GitHub project for changelog for each release version.
This software is released under the terms of the MIT license.