Class Stats

Implementation of Node's Stats.

Attribute descriptions are from `man 2 stat'

See

Hierarchy (View Summary)

StatsCommon<number>
- Stats

Implements

Stats
StatsLike

Index

Constructors

constructor

new Stats(
__namedParameters?: Partial<StatsLike<number | bigint> & InodeFields>,
): Stats
Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
Parameters
- __namedParameters: Partial<StatsLike<number | bigint> & InodeFields> = {}
Returns Stats
Inherited from StatsCommon.constructor
- Defined in src/vfs/stats.ts:187

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

`Optional` `Internal`data

data?: number

Used by inodes

dev

dev: number = ...

ID of device containing file

`Optional` `Internal`flags

flags?: number

Used by inodes

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.

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

`Optional` `Internal`version

version?: number

Used by inodes

Accessors

atime

get atime(): Date
Returns Date
Implementation of Node.Stats.atime
Inherited from StatsCommon.atime
- Defined in src/vfs/stats.ts:116
set atime(value: Date): void
Parameters
- value: Date
Returns void
Implementation of Node.Stats.atime
Inherited from StatsCommon.atime
- Defined in src/vfs/stats.ts:120

atimeNs

get atimeNs(): bigint
Returns bigint
Inherited from StatsCommon.atimeNs
- Defined in src/vfs/stats.ts:247

birthtime

get birthtime(): Date
Returns Date
Implementation of Node.Stats.birthtime
Inherited from StatsCommon.birthtime
- Defined in src/vfs/stats.ts:155
set birthtime(value: Date): void
Parameters
- value: Date
Returns void
Implementation of Node.Stats.birthtime
Inherited from StatsCommon.birthtime
- Defined in src/vfs/stats.ts:159

birthtimeNs

get birthtimeNs(): bigint
Returns bigint
Inherited from StatsCommon.birthtimeNs
- Defined in src/vfs/stats.ts:259

blocks

get blocks(): T
Returns T
Implementation of Node.Stats.blocks
Inherited from StatsCommon.blocks
- Defined in src/vfs/stats.ts:65
set blocks(value: T): void
Parameters
- value: T
Returns void
Implementation of Node.Stats.blocks
Inherited from StatsCommon.blocks
- Defined in src/vfs/stats.ts:69

ctime

get ctime(): Date
Returns Date
Implementation of Node.Stats.ctime
Inherited from StatsCommon.ctime
- Defined in src/vfs/stats.ts:142
set ctime(value: Date): void
Parameters
- value: Date
Returns void
Implementation of Node.Stats.ctime
Inherited from StatsCommon.ctime
- Defined in src/vfs/stats.ts:146

ctimeNs

get ctimeNs(): bigint
Returns bigint
Inherited from StatsCommon.ctimeNs
- Defined in src/vfs/stats.ts:255

mtime

get mtime(): Date
Returns Date
Implementation of Node.Stats.mtime
Inherited from StatsCommon.mtime
- Defined in src/vfs/stats.ts:129
set mtime(value: Date): void
Parameters
- value: Date
Returns void
Implementation of Node.Stats.mtime
Inherited from StatsCommon.mtime
- Defined in src/vfs/stats.ts:133

mtimeNs

get mtimeNs(): bigint
Returns bigint
Inherited from StatsCommon.mtimeNs
- Defined in src/vfs/stats.ts:251

Methods

`Protected`_convert

_convert(arg: string | number | bigint | boolean): number
Parameters
- arg: string | number | bigint | boolean
Returns number
Inherited from StatsCommon._convert
- Defined in src/vfs/stats.ts:61

hasAccess

hasAccess(mode: number, context?: V_Context): 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
- Optionalcontext: V_Context
Returns boolean
True if the request has access, false if the request does not
Inherited from StatsCommon.hasAccess
- Defined in src/vfs/stats.ts:243

isBlockDevice

isBlockDevice(): boolean
Returns boolean
Implementation of Node.Stats.isBlockDevice
Inherited from StatsCommon.isBlockDevice
- Defined in src/vfs/stats.ts:221

isCharacterDevice

isCharacterDevice(): boolean
Returns boolean
Implementation of Node.Stats.isCharacterDevice
Inherited from StatsCommon.isCharacterDevice
- Defined in src/vfs/stats.ts:225

isDirectory

isDirectory(): boolean
Returns boolean
Implementation of Node.Stats.isDirectory
Inherited from StatsCommon.isDirectory
- Defined in src/vfs/stats.ts:209

isFIFO

isFIFO(): boolean
Returns boolean
Implementation of Node.Stats.isFIFO
Inherited from StatsCommon.isFIFO
- Defined in src/vfs/stats.ts:229

isFile

isFile(): boolean
Returns boolean
Implementation of Node.Stats.isFile
Inherited from StatsCommon.isFile
- Defined in src/vfs/stats.ts:205

isSocket

isSocket(): boolean
Returns boolean
Implementation of Node.Stats.isSocket
Inherited from StatsCommon.isSocket
- Defined in src/vfs/stats.ts:217

isSymbolicLink

isSymbolicLink(): boolean
Returns boolean
Implementation of Node.Stats.isSymbolicLink
Inherited from StatsCommon.isSymbolicLink
- Defined in src/vfs/stats.ts:213

toJSON

toJSON(): StatsLike<number> & InodeFields
Returns StatsLike<number> & InodeFields
Inherited from StatsCommon.toJSON
- Defined in src/vfs/stats.ts:233

Class Stats

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Stats

Properties

Protected_isBigint

atimeMs

birthtimeMs

blksize

ctimeMs

Optional Internaldata

dev

Optional Internalflags

gid

ino

mode

mtimeMs

nlink

rdev

size

uid

Optional Internalversion

Accessors

atime

Returns Date

Parameters

Returns void

atimeNs

Returns bigint

birthtime

Returns Date

Parameters

Returns void

birthtimeNs

Returns bigint

blocks

Returns T

Parameters

Returns void

ctime

Returns Date

Parameters

Returns void

ctimeNs

Returns bigint

mtime

Returns Date

Parameters

Returns void

mtimeNs

Returns bigint

Methods

Protected_convert

Parameters

Returns number

hasAccess

Parameters

Returns boolean

isBlockDevice

Returns boolean

isCharacterDevice

Returns boolean

isDirectory

Returns boolean

isFIFO

Returns boolean

isFile

Returns boolean

isSocket

Returns boolean

isSymbolicLink

`Protected`_isBigint

`Optional` `Internal`data

`Optional` `Internal`flags

`Optional` `Internal`version

`Protected`_convert