Class StatsCommon<T>Abstract

constructor

• new StatsCommon<T>(__namedParameters?): StatsCommon<T>

• Creates a new stats instance from a stats-like object. Can be used to copy stats (note)

  Type Parameters

  • T extends number | bigint

  Parameters

  • __namedParameters: Partial<StatsLike<number | bigint>> = {}

  Returns StatsCommon<T>

atimeMs

birthtimeMs

blksize

ctimeMs

dev

Optional fileData

gid

ino

mode

mtimeMs

nlink

rdev

size

uid

atime

• get atime(): Date

• Returns Date

• set atime(value): void

• Parameters

  • value: Date

  Returns void

atimeNs

• get atimeNs(): bigint

• Returns bigint

birthtime

• get birthtime(): Date

• Returns Date

• set birthtime(value): void

• Parameters

  • value: Date

  Returns void

birthtimeNs

• get birthtimeNs(): bigint

• Returns bigint

blocks

• get blocks(): T

• Returns T

ctime

• get ctime(): Date

• Returns Date

• set ctime(value): void

• Parameters

  • value: Date

  Returns void

ctimeNs

• get ctimeNs(): bigint

• Returns bigint

mtime

• get mtime(): Date

• Returns Date

• set mtime(value): void

• Parameters

  • value: Date

  Returns void

mtimeNs

• get mtimeNs(): bigint

• Returns bigint

chmod

• chmod(mode): void
• Internal

  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
• Internal

  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

cred

• cred(uid?, gid?): Credentials
• Internal

  Convert the current stats object into a credentials object

  Parameters

  • uid: number = ...
  • gid: number = ...

  Returns Credentials

hasAccess

• hasAccess(mode, cred): boolean
• Internal

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

  Parameters

  • mode: number

    The requested access, combination of W_OK, R_OK, and X_OK
  • cred: Credentials

    The requesting credentials

  Returns 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

  True if this item is a directory.

isFIFO

• isFIFO(): boolean

• Returns boolean

isFile

• isFile(): boolean

• Returns boolean

  true if this item is a file.

isSocket

• isSocket(): boolean

• Returns boolean

isSymbolicLink

• isSymbolicLink(): boolean

• Returns boolean

  true if this item is a symbolic link