• Version 3.0.0
  • Published
  • 11.1 kB
  • No dependencies
  • MIT license


npm i @nodelib/fs.stat
yarn add @nodelib/fs.stat
pnpm add @nodelib/fs.stat


Get the status of a file with some features



function stat

stat: typeof stat;

    function statSync

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


      class Settings

      class Settings {}


        constructor(options?: Options);
          readonly followSymbolicLink: boolean;

            property fs

            readonly fs: fs.FileSystemAdapter;
              readonly markSymbolicLink: boolean;
                readonly throwErrorOnBrokenSymbolicLink: boolean;


                  interface FileSystemAdapter

                  interface FileSystemAdapter {}

                    property lstat

                    lstat: StatAsynchronousMethod;

                      property lstatSync

                      lstatSync: StatSynchronousMethod;

                        property stat

                        stat: StatAsynchronousMethod;

                          property statSync

                          statSync: StatSynchronousMethod;

                            interface Options

                            interface Options {}
                              followSymbolicLink?: boolean;

                                property fs

                                fs?: Partial<fs.FileSystemAdapter>;
                                  markSymbolicLink?: boolean;
                                    throwErrorOnBrokenSymbolicLink?: boolean;

                                      Type Aliases

                                      type AsyncCallback

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

                                        type StatAsynchronousMethod

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

                                          type Stats

                                          type Stats = fs.Stats;

                                            type StatSynchronousMethod

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


                                              namespace stat

                                              namespace stat {}

                                                Package Files (5)

                                                Dependencies (0)

                                                No dependencies.

                                                Dev Dependencies (1)

                                                Peer Dependencies (0)

                                                No peer dependencies.


                                                To add a badge like this onejsDocs.io badgeto 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
                                                • 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>