Node fs.lstatSync function | API Reference

Node fs.lstatSync function | API Reference | BunBuild Docs Reference Guides Blog Discord/node:fs/lstatSyncFlstatSync

Search the reference...

Build Docs Reference Guides Blog Discord/node:fs/lstatSyncFlstatSync

function

fs.lstatSyncfunction lstatSync(path: PathLike): Stats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

function lstatSync(path: PathLike,options?: StatOptions & { bigint: false; throwIfNoEntry: true }): Stats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

function lstatSync(path: PathLike,options: StatOptions & { bigint: true; throwIfNoEntry: true }): BigIntStats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

function lstatSync(path: PathLike,options: StatOptions & { bigint: false; throwIfNoEntry: false }): undefined | Stats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

function lstatSync(path: PathLike,options: StatOptions & { bigint: true; throwIfNoEntry: false }): undefined | BigIntStats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

function lstatSync(path: PathLike,options: StatOptions & { throwIfNoEntry: true }): Stats | BigIntStats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

function lstatSync(path: PathLike,options?: StatOptions): undefined | Stats | BigIntStats;

Synchronous lstat(2) - Get file status. Does not dereference symbolic links.

@param path

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

Referenced typestype PathLike = string | Buffer | URL

Valid types for path values in "fs".

class Stats

A fs.Stats object provides information about a file.

Objects returned from stat, lstat, fstat, and their synchronous counterparts are of this type. If bigint in the options passed to those methods is true, the numeric values will be bigint instead of number, and the object will contain additional nanosecond-precision properties suffixed with Ns. Stat objects are not to be created directly using the new keyword.

Stats {
dev: 2114,
ino: 48064969,
mode: 33188,
nlink: 1,
uid: 85,
gid: 100,
rdev: 0,
size: 527,
blksize: 4096,
blocks: 8,
atimeMs: 1318289051000.1,
mtimeMs: 1318289051000.1,
ctimeMs: 1318289051000.1,
birthtimeMs: 1318289051000.1,
atime: Mon, 10 Oct 2011 23:24:11 GMT,
mtime: Mon, 10 Oct 2011 23:24:11 GMT,
ctime: Mon, 10 Oct 2011 23:24:11 GMT,
birthtime: Mon, 10 Oct 2011 23:24:11 GMT }

bigint version:

BigIntStats {
dev: 2114n,
ino: 48064969n,
mode: 33188n,
nlink: 1n,
uid: 85n,
gid: 100n,
rdev: 0n,
size: 527n,
blksize: 4096n,
blocks: 8n,
atimeMs: 1318289051000n,
mtimeMs: 1318289051000n,
ctimeMs: 1318289051000n,
birthtimeMs: 1318289051000n,
atimeNs: 1318289051000000000n,
mtimeNs: 1318289051000000000n,
ctimeNs: 1318289051000000000n,
birthtimeNs: 1318289051000000000n,
atime: Mon, 10 Oct 2011 23:24:11 GMT,
mtime: Mon, 10 Oct 2011 23:24:11 GMT,
ctime: Mon, 10 Oct 2011 23:24:11 GMT,
birthtime: Mon, 10 Oct 2011 23:24:11 GMT }

atime: DateatimeMs: numberbirthtime: DatebirthtimeMs: numberblksize: numberblocks: numberctime: DatectimeMs: numberdev: numbergid: numberino: numbermode: numbermtime: DatemtimeMs: numbernlink: numberrdev: numbersize: numberuid: numberisBlockDevice(): boolean;isCharacterDevice(): boolean;isDirectory(): boolean;isFIFO(): boolean;isFile(): boolean;isSocket(): boolean;isSymbolicLink(): boolean;interface StatOptions bigint?: booleanthrowIfNoEntry?: booleaninterface BigIntStats atime: DateatimeMs: bigintatimeNs: bigintbirthtime: DatebirthtimeMs: bigintbirthtimeNs: bigintblksize: bigintblocks: bigintctime: DatectimeMs: bigintctimeNs: bigintdev: bigintgid: bigintino: bigintmode: bigintmtime: DatemtimeMs: bigintmtimeNs: bigintnlink: bigintrdev: bigintsize: bigintuid: bigintisBlockDevice(): boolean;isCharacterDevice(): boolean;isDirectory(): boolean;isFIFO(): boolean;isFile(): boolean;isSocket(): boolean;isSymbolicLink(): boolean;

Resources

Reference Docs Guides Discord Merch Store GitHub Blog

Toolkit

Runtime Package manager Test runner Bundler Package runner

Project

Bun 1.0 Bun 1.1 Bun 1.2 Bun 1.3 Roadmap Contributing License

Baked with ❤️ in San Francisco

We're hiring →

Node fs.lstatSync function | API Reference | Bun

Node fs.lstatSync function | API Reference | Bun,AI智能索引,全网链接索引,智能导航,网页索引