@nodelib/fs.stat

Install

npm i @nodelib/fs.stat

yarn add @nodelib/fs.stat

pnpm add @nodelib/fs.stat

Get the status of a file with some features

stat: typeof stat;

statSync: (path: string, optionsOrSettings?: Options | Settings) => fs.Stats;

class Settings {}

constructor(options?: Options);

readonly followSymbolicLink: boolean;

readonly fs: fs.FileSystemAdapter;

readonly markSymbolicLink: boolean;

readonly throwErrorOnBrokenSymbolicLink: boolean;

interface FileSystemAdapter {}

lstat: StatAsynchronousMethod;

lstatSync: StatSynchronousMethod;

stat: StatAsynchronousMethod;

statSync: StatSynchronousMethod;

interface Options {}

followSymbolicLink?: boolean;

fs?: Partial<fs.FileSystemAdapter>;

markSymbolicLink?: boolean;

throwErrorOnBrokenSymbolicLink?: boolean;

type AsyncCallback = (error: ErrnoException | null, stats: Stats) => void;

type StatAsynchronousMethod = (
    path: string,
    callback: (error: ErrnoException | null, stats: fs.Stats) => void
) => void;

type Stats = fs.Stats;

type StatSynchronousMethod = (path: string) => fs.Stats;

namespace stat {}

No dependencies.

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@nodelib/fs.stat.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@nodelib/fs.stat)

HTML

<a href="https://www.jsdocs.io/package/@nodelib/fs.stat"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>