Path.stat() method

pathlib-ts > Path > stat

Path.stat() method

Returns filesystem metadata asynchronously.

Signature:

stat(options?: {
        followSymlinks?: boolean;
    }): Promise<Stats>;

Parameters

Parameter	Type	Description
options	{ followSymlinks?: boolean; }	(Optional) Optional follow-symlink toggle.

Returns:

Promise<Stats>

A promise that resolves with fs.Stats information.

Remarks

Accepts followSymlinks to align with CPython behaviour.

Example

Asserting a directory exists before reading

import { Path } from "pathlib-ts";

const dataDir = new Path("./data");
const stats = await dataDir.stat();
console.log(stats.isDirectory());