Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

@nodelib/fs.stat

Package Overview
Dependencies
0
Maintainers
1
Versions
13
Issues
File Explorer

Advanced tools

@nodelib/fs.stat

Get the status of a file with some features

    2.0.5latest

Version published
Maintainers
1
Weekly downloads
35,400,558
increased by5.12%

Weekly downloads

Readme

Source

@nodelib/fs.stat

Get the status of a file with some features.

:bulb: Highlights

Wrapper around standard method fs.lstat and fs.stat with some features.

  • :beginner: Normally follows symbolic link.
  • :gear: Can safely work with broken symbolic link.

Install

npm install @nodelib/fs.stat

Usage

import * as fsStat from '@nodelib/fs.stat'; fsStat.stat('path', (error, stats) => { /* … */ });

API

.stat(path, [optionsOrSettings], callback)

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) => { /* … */ });

.statSync(path, [optionsOrSettings])

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());
path
  • Required: true
  • Type: string | Buffer | URL

A path to a file. If a URL is provided, it must use the file: protocol.

optionsOrSettings
  • Required: false
  • Type: Options | Settings
  • Default: An instance of Settings class

An 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 the Settings class.

Settings([options])

A class of full settings of the package.

const settings = new fsStat.Settings({ followSymbolicLink: false }); const stats = fsStat.stat('path', settings);

Options

  • Type: boolean
  • Default: true

Follow symbolic link or not. Call fs.stat on symbolic link if true.

  • Type: boolean
  • Default: 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.

  • Type: boolean
  • Default: true

Throw an error when symbolic link is broken if true or safely return lstat call if false.

fs

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 } });

Changelog

See the Releases section of our GitHub project for changelog for each release version.

License

This software is released under the terms of the MIT license.

Keywords

FAQs

What is @nodelib/fs.stat?

Get the status of a file with some features

Is @nodelib/fs.stat popular?

The npm package @nodelib/fs.stat receives a total of 29,772,470 weekly downloads. As such, @nodelib/fs.stat popularity was classified as popular.

Is @nodelib/fs.stat well maintained?

We found that @nodelib/fs.stat demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 04 Jun 2021

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc