FileInfo

Defined in: plugins/fs/guest-js/index.ts:89

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

Since

2.0.0

Properties

atime

atime: null | Date

Defined in: plugins/fs/guest-js/index.ts:120

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

birthtime: null | Date

Defined in: plugins/fs/guest-js/index.ts:126

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

blksize: null | number

Defined in: plugins/fs/guest-js/index.ts:203

Blocksize for filesystem I/O.

Platform-specific

Windows: Unsupported.

blocks

blocks: null | number

Defined in: plugins/fs/guest-js/index.ts:211

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

Platform-specific

Windows: Unsupported.

dev

dev: null | number

Defined in: plugins/fs/guest-js/index.ts:146

ID of the device containing the file.

Platform-specific

Windows: Unsupported.

fileAttributes

fileAttributes: null | number

Defined in: plugins/fs/guest-js/index.ts:138

This field contains the file system attribute information for a file or directory. For possible values and their descriptions, see File Attribute Constants in the Windows Dev Center

Platform-specific

macOS / Linux / Android / iOS: Unsupported.

gid

gid: null | number

Defined in: plugins/fs/guest-js/index.ts:187

Group ID of the owner of this file.

Platform-specific

Windows: Unsupported.

ino

ino: null | number

Defined in: plugins/fs/guest-js/index.ts:154

Inode number.

Platform-specific

Windows: Unsupported.

isDirectory

isDirectory: boolean

Defined in: plugins/fs/guest-js/index.ts:99

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

isFile

isFile: boolean

Defined in: plugins/fs/guest-js/index.ts:94

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

isSymlink

isSymlink: boolean

Defined in: plugins/fs/guest-js/index.ts:104

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

mode

mode: null | number

Defined in: plugins/fs/guest-js/index.ts:163

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

Platform-specific

Windows: Unsupported.

mtime

mtime: null | Date

Defined in: plugins/fs/guest-js/index.ts:114

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.