Skip to content
NetWiv

FileInfo

Module @netwiv/api/plugins/fs · Kind Interface

import { FileInfo } from '@netwiv/api/plugins/fs';

A FileInfo describes a file and is returned by stat, lstat or fstat.

Members

Section titled “Members”

atime

Section titled “atime”
atime: Date | null

The last access time of the file. This corresponds to the atime field from stat on Unix and ftLastAccessTime on Windows. This may not be available on all platforms.

birthtime

Section titled “birthtime”
birthtime: Date | null

The creation time of the file. This corresponds to the birthtime field from stat on Mac/BSD and ftCreationTime on Windows. This may not be available on all platforms.

blksize

Section titled “blksize”
blksize: number | null

Blocksize for filesystem I/O.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

blocks

Section titled “blocks”
blocks: number | null

Number of blocks allocated to the file, in 512-byte units.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

dev

Section titled “dev”
dev: number | null

ID of the device containing the file.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

fileAttributes

Section titled “fileAttributes”
fileAttributes: number | null

This field contains the file system attribute information for a file or directory. For possible values and their descriptions, see {@link https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants File Attribute Constants} in the Windows Dev Center

Platform-specific

Section titled “Platform-specific”
  • macOS / Linux / Android / iOS: Unsupported.

gid

Section titled “gid”
gid: number | null

Group ID of the owner of this file.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

ino

Section titled “ino”
ino: number | null

Inode number.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

isDirectory

Section titled “isDirectory”
isDirectory: boolean

True if this is info for a regular directory. Mutually exclusive to FileInfo.isFile and FileInfo.isSymlink.

isFile

Section titled “isFile”
isFile: boolean

True if this is info for a regular file. Mutually exclusive to FileInfo.isDirectory and FileInfo.isSymlink.

Section titled “isSymlink”
isSymlink: boolean

True if this is info for a symlink. Mutually exclusive to FileInfo.isFile and FileInfo.isDirectory.

mode

Section titled “mode”
mode: number | null

The underlying raw st_mode bits that contain the standard Unix permissions for this file/directory.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

mtime

Section titled “mtime”
mtime: Date | null

The last modification time of the file. This corresponds to the mtime field from stat on Linux/Mac OS and ftLastWriteTime on Windows. This may not be available on all platforms.

Section titled “nlink”
nlink: number | null

Number of hard links pointing to this file.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

rdev

Section titled “rdev”
rdev: number | null

Device ID of this file.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

readonly

Section titled “readonly”
readonly: boolean

Whether this is a readonly (unwritable) file.

size

Section titled “size”
size: number

The size of the file, in bytes.

uid

Section titled “uid”
uid: number | null

User ID of the owner of this file.

Platform-specific

Section titled “Platform-specific”
  • Windows: Unsupported.

Upstream since 2.0.0

Descriptions come from the pinned @tauri-apps/plugin-fs@2.5.2 declarations (MIT OR Apache-2.0); imports are shown with @netwiv/api paths.