Class StatsCommon<T>Abstract

Provides information about a particular entry in the file system. Common code used by both Stats and BigIntStats.

Type Parameters

  • T extends number | bigint

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_isBigint atimeMs birthtimeMs blksize ctimeMs dev fileData? gid ino mode mtimeMs nlink rdev size uid

Accessors

atime atimeNs birthtime birthtimeNs blocks ctime ctimeNs mtime mtimeNs

Methods

_convert chmod chown hasAccess isBlockDevice isCharacterDevice isDirectory isFIFO isFile isSocket isSymbolicLink

Constructors

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>

Properties

Protected Abstract_isBigint

_isBigint: T extends bigint
    ? true
    : false

atimeMs

atimeMs: T

Time of last access, since epoch

birthtimeMs

birthtimeMs: T

Time of file creation, since epoch

blksize

blksize: T = ...

Block size for file system I/O

ctimeMs

ctimeMs: T

Time of last time file status was changed, since epoch

dev

dev: T = ...

ID of device containing file

OptionalfileData

fileData?: Uint8Array

Some file systems stash data on stats objects.

gid

gid: T = ...

Group ID of owner

ino

ino: T = ...

Inode number

mode

mode: T

Unix-style file mode (e.g. 0o644) that includes the type of the item. Type of the item can be FILE, DIRECTORY, SYMLINK, or SOCKET

mtimeMs

mtimeMs: T

Time of last modification, since epoch

nlink

nlink: T = ...

Number of hard links

rdev

rdev: T = ...

Device ID (if special file)

size

size: T

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

uid

uid: T = ...

User ID of owner

Accessors

atime

  • get atime(): Date

  • Returns Date

  • set atime(value): void

  • Parameters

    • value: Date

    Returns void

atimeNs

birthtime

  • get birthtime(): Date

  • Returns Date

  • set birthtime(value): void

  • Parameters

    • value: Date

    Returns void

birthtimeNs

blocks

  • get blocks(): T

  • Returns T

ctime

  • get ctime(): Date

  • Returns Date

  • set ctime(value): void

  • Parameters

    • value: Date

    Returns void

ctimeNs

mtime

  • get mtime(): Date

  • Returns Date

  • set mtime(value): void

  • Parameters

    • value: Date

    Returns void

mtimeNs

Methods

Protected_convert

  • _convert(arg): T

  • Parameters

    • arg:
          | string
          | number
          | bigint
          | boolean

    Returns T

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.

    Parameters

    • mode: number

    Returns void

    Deprecated

    This will be removed in the next minor release since it is internal

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
    • gid: number

    Returns void

    Deprecated

    This will be removed in the next minor release since it is internal

hasAccess

  • hasAccess(mode): 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

    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

isFIFO

  • isFIFO(): boolean

  • Returns boolean

isFile

  • isFile(): boolean

  • Returns boolean

isSocket

  • isSocket(): boolean

  • Returns boolean

isSymbolicLink

  • isSymbolicLink(): boolean

  • Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods