Function lstat

lstat(path, callback): void
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: Stats
      Returns void
Returns void
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293
lstat(path, options, callback): void
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- options: undefined | StatOptions & {
  bigint?: false;
  }
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: Stats
      Returns void
Returns void
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293
lstat(path, options, callback): void
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- options: StatOptions & {
  bigint: true;
  }
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: BigIntStats
      Returns void
Returns void
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293
lstat(path, options, callback): void
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- options: undefined | StatOptions
- callback: ((err, stats) => void)
  - - (err, stats): void
    - Parameters
      err: null | ErrnoException
      stats: Stats | BigIntStats
      Returns void
Returns void
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293
lstat(path, options?): Promise<Stats>
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- Optional options: StatOptions & {
  bigint?: false;
  }
Returns Promise<Stats>
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293
lstat(path, options): Promise<BigIntStats>
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- options: StatOptions & {
  bigint: true;
  }
Returns Promise<BigIntStats>
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293
lstat(path, options?): Promise<Stats | BigIntStats>
Retrieves the fs.Stats for the symbolic link referred to by the path. The callback gets two arguments (err, stats) where stats is a fs.Stats object. lstat() is identical to stat(), except that if path is a symbolic link, then the link itself is stat-ed, not the file that it refers to.

See the POSIX lstat(2) documentation for more details.
Parameters
- path: PathLike
- Optional options: StatOptions
Returns Promise<Stats | BigIntStats>
Since
v0.1.30

See
- fs.lstat
- fs.promises.lstat
- Defined in src/fs/index.ts:293

Index

Methods

__promisify__

Methods

promisify

__promisify__(path, options?): Promise<Stats>
Asynchronous lstat(2) - Get file status. Does not dereference symbolic links.
Parameters
- path: PathLike
  A path to a file. If a URL is provided, it must use the file: protocol.
- Optional options: StatOptions & {
  bigint?: false;
  }
Returns Promise<Stats>
- Defined in node_modules/.pnpm/@types+node@20.11.10/node_modules/@types/node/fs.d.ts:1166
__promisify__(path, options): Promise<BigIntStats>
Parameters
- path: PathLike
- options: StatOptions & {
  bigint: true;
  }
Returns Promise<BigIntStats>
- Defined in node_modules/.pnpm/@types+node@20.11.10/node_modules/@types/node/fs.d.ts:1172
__promisify__(path, options?): Promise<Stats | BigIntStats>
Parameters
- path: PathLike
- Optional options: StatOptions
Returns Promise<Stats | BigIntStats>
- Defined in node_modules/.pnpm/@types+node@20.11.10/node_modules/@types/node/fs.d.ts:1178

Function lstat

Parameters

path: PathLike

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: Stats

Returns void

Returns void

Since

See

Parameters

path: PathLike

options: undefined | StatOptions & { bigint?: false; }

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: Stats

Returns void

Returns void

Since

See

Parameters

path: PathLike

options: StatOptions & { bigint: true; }

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: BigIntStats

Returns void

Returns void

Since

See

Parameters

path: PathLike

options: undefined | StatOptions

callback: ((err, stats) => void)

Parameters

err: null | ErrnoException

stats: Stats | BigIntStats

Returns void

Returns void

Since

See

Parameters

path: PathLike

Optional options: StatOptions & { bigint?: false; }

Returns Promise<Stats>

Since

See

Parameters

path: PathLike

options: StatOptions & { bigint: true; }

Returns Promise<BigIntStats>

Since

See

Parameters

path: PathLike

Optional options: StatOptions

Returns Promise<Stats | BigIntStats>

Since

See

Index

Methods

Methods

__promisify__

Parameters

path: PathLike

Optional options: StatOptions & { bigint?: false; }

Returns Promise<Stats>

Parameters

path: PathLike

options: StatOptions & { bigint: true; }

Returns Promise<BigIntStats>

Parameters

path: PathLike

Optional options: StatOptions

Returns Promise<Stats | BigIntStats>

Settings

Member Visibility

options: undefined | StatOptions & {
bigint?: false;
}

options: StatOptions & {
bigint: true;
}

`Optional` options: StatOptions & {
bigint?: false;
}

options: StatOptions & {
bigint: true;
}

`Optional` options: StatOptions

promisify

`Optional` options: StatOptions & {
bigint?: false;
}

options: StatOptions & {
bigint: true;
}

`Optional` options: StatOptions