UseGetFileStats
katanakit-js / useGetFileStats
Function: useGetFileStats()
Section titled “Function: useGetFileStats()”function useGetFileStats(path): Promise< FilesystemResult<{ accessedAt: number; createdAt: number; isDirectory: boolean; isFile: boolean; isSymbolicLink: boolean; modifiedAt: number; size: number; }>>;Defined in: infrastructure/filesystem/filesystem.service.ts:403
Returns a portable stats subset for a file or directory.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
path |
string |
Path to inspect (follows symlinks). |
Returns
Section titled “Returns”Promise<FilesystemResult<{
accessedAt: number;
createdAt: number;
isDirectory: boolean;
isFile: boolean;
isSymbolicLink: boolean;
modifiedAt: number;
size: number;
}>>
Safe Result with size, type flags and epoch-ms timestamps.
Example
Section titled “Example”const result = await useGetFileStats("assets/logo.png");if (result.ok) console.log(result.data.size);