stat

Get file/directory metadata. Follows symlinks; use lstat to inspect the link itself.

Basic usage

import { stat } from '@rush-fs/core'
 
const s = await stat('./package.json')
console.log(s.size, s.isFile(), s.isDirectory())
console.log(s.mtime, s.atime)

Methods

stat(path)

Async. Returns Promise<Stats>.

Stats: Numeric fields (dev, mode, nlink, uid, gid, rdev, blksize, ino, size, blocks, atimeMs, mtimeMs, ctimeMs, birthtimeMs), Date fields (atime, mtime, ctime, birthtime), methods (isFile(), isDirectory(), isSymbolicLink(), etc.). Error distinction: ENOENT vs EACCES.

statSync(path)

Sync. Same arguments; returns Stats or throws.

Performance

From repo benchmarks (pnpm build && pnpm bench):

On par with Node.js; small N-API overhead per call.

Notes

• Symlinks: stat follows symlinks; use lstat for the link metadata.
• Dates: atime, mtime, ctime, birthtime are Date objects; *Ms are numbers.