Class Stats

constructor

• new Stats(itemType?, size?, mode?, atimeMs?, mtimeMs?, ctimeMs?, uid?, gid?, birthtimeMs?): Stats

• Provides information about a particular entry in the file system.

  Parameters

  • itemType: FileType = FileType.FILE

    Type of the item (FILE, DIRECTORY, SYMLINK, or SOCKET)

  • size: number | bigint = -1

    Size of the item in bytes. For directories/symlinks, this is normally the size of the struct that represents the item.

  • Optional mode: number | bigint

    Unix-style file mode (e.g. 0o644)

  • Optional atimeMs: number | bigint

    time of last access, in milliseconds since epoch

  • Optional mtimeMs: number | bigint

    time of last modification, in milliseconds since epoch

  • Optional ctimeMs: number | bigint

    time of last time file status was changed, in milliseconds since epoch

  • Optional uid: number | bigint

    the id of the user that owns the file

  • Optional gid: number | bigint

    the id of the group that owns the file

  • Optional birthtimeMs: number | bigint

    time of file creation, in milliseconds since epoch

  Returns Stats

atimeMs

birthtimeMs

blksize

blocks

ctimeMs

dev

fileData

gid

ino

mode

mtimeMs

nlink

rdev

size

uid

atime

• get atime(): Date

• Returns Date

birthtime

• get birthtime(): Date

• Returns Date

ctime

• get ctime(): Date

• Returns Date

mtime

• get mtime(): Date

• Returns Date

chmod

• chmod(mode): void

• Change the mode of the file. We use this helper function to prevent messing up the type of the file, which is encoded in mode.

  Parameters

  • mode: number

  Returns void

chown

• chown(uid, gid): void

• Change the owner user/group of the file. This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)

  Parameters

  • uid: number | bigint

  • gid: number | bigint

  Returns void

getCred

• getCred(uid?, gid?): Cred

• Convert the current stats object into a cred object

  Parameters

  • uid: number = ...

  • gid: number = ...

  Returns Cred

hasAccess

• hasAccess(mode, cred): boolean

• Checks if a given user/group has access to this item

  Parameters

  • mode: number

    The request access as 4 bits (unused, read, write, execute)

  • cred: Cred

  Returns boolean

  [Boolean] True if the request has access, false if the request does not

isBlockDevice

• isBlockDevice(): boolean

• Returns boolean

isCharacterDevice

• isCharacterDevice(): boolean

• Returns boolean

isDirectory

• isDirectory(): boolean

• Returns boolean

  [Boolean] True if this item is a directory.

isFIFO

• isFIFO(): boolean

• Returns boolean

isFile

• isFile(): boolean

• Returns boolean

  [Boolean] True if this item is a file.

isSocket

• isSocket(): boolean

• Returns boolean

isSymbolicLink

• isSymbolicLink(): boolean

• Returns boolean

  [Boolean] True if this item is a symbolic link (only valid through lstat)