Class Stats

Implementation of Node's Stats.

Attribute descriptions are from `man 2 stat'

See

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

Properties

Protected_isBigint

_isBigint: false = ...

atimeMs

atimeMs: number

Time of last access, since epoch

birthtimeMs

birthtimeMs: number

Time of file creation, since epoch

blksize

blksize: number = ...

Block size for file system I/O

ctimeMs

ctimeMs: number

Time of last time file status was changed, since epoch

dev

dev: number = ...

ID of device containing file

OptionalfileData

fileData?: Uint8Array

Some file systems stash data on stats objects.

gid

gid: number = ...

Group ID of owner

ino

ino: number = ...

Inode number

mode

mode: number

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

Time of last modification, since epoch

nlink

nlink: number = ...

Number of hard links

rdev

rdev: number = ...

Device ID (if special file)

size

size: number

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

uid

uid: number = ...

User ID of owner

Accessors

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

Methods

Protected_convert

  • _convert(arg): number

  • Parameters

    • arg:
          | string
          | number
          | bigint
          | boolean

    Returns number

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

isCharacterDevice

isDirectory

isFIFO

isFile

isSocket

isSymbolicLink

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods