statUtils

Index

Classes

• BigIntStatsEntry
• DirEntry
• StatEntry

Variables

• DEFAULT_MODE

Functions

• areStatsEqual
• clearStats
• convertToBigIntStats
• makeDefaultStats
• makeEmptyStats

Classes

BigIntStatsEntry

BigIntStatsEntry:

constructor

• new BigIntStatsEntry(): BigIntStatsEntry

• Returns BigIntStatsEntry

atime

atime: Date = ...

atimeMs

atimeMs: bigint = ...

atimeNs

atimeNs: bigint = ...

birthtime

birthtime: Date = ...

birthtimeMs

birthtimeMs: bigint = ...

birthtimeNs

birthtimeNs: bigint = ...

blksize

blksize: bigint = ...

blocks

blocks: bigint = ...

ctime

ctime: Date = ...

ctimeMs

ctimeMs: bigint = ...

ctimeNs

ctimeNs: bigint = ...

dev

dev: bigint = ...

gid

gid: bigint = ...

ino

ino: bigint = ...

mode

mode: bigint = ...

mtime

mtime: Date = ...

mtimeMs

mtimeMs: bigint = ...

mtimeNs

mtimeNs: bigint = ...

nlink

nlink: bigint = ...

rdev

rdev: bigint = ...

size

size: bigint = ...

uid

uid: bigint = ...

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

DirEntry

DirEntry<T>:

Type parameters

• T = undefined

constructor

• new DirEntry<T>(): DirEntry<T>

• Type parameters

  • T = undefined

  Returns DirEntry<T>

publicmode

mode: number = 0

publicname

name: Filename = ...

publicpath

path: T = ...

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

StatEntry

StatEntry:

constructor

• new StatEntry(): StatEntry

• Returns StatEntry

atime

atime: Date = ...

atimeMs

atimeMs: number = 0

birthtime

birthtime: Date = ...

birthtimeMs

birthtimeMs: number = 0

blksize

blksize: number = 0

blocks

blocks: number = 1

ctime

ctime: Date = ...

ctimeMs

ctimeMs: number = 0

dev

dev: number = 0

gid

gid: number = 0

ino

ino: number = 0

mode

mode: number = DEFAULT_MODE

mtime

mtime: Date = ...

mtimeMs

mtimeMs: number = 0

nlink

nlink: number = 1

rdev

rdev: number = 0

size

size: number = 0

uid

uid: number = 0

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

Variables

constDEFAULT_MODE

DEFAULT_MODE: number = ...

Functions

areStatsEqual

• areStatsEqual(a: Stats | BigIntStatsEntry, b: Stats | BigIntStatsEntry): boolean

• Parameters

  • a: Stats | BigIntStatsEntry

  • b: Stats | BigIntStatsEntry

  Returns boolean

clearStats

• clearStats(stats: Stats | BigIntStats): Stats | BigIntStats

• Mutates the provided stats object to zero it out then returns it for convenience

  ---

  Parameters

  • stats: Stats | BigIntStats

  Returns Stats | BigIntStats

convertToBigIntStats

• convertToBigIntStats(stats: Stats): BigIntStats

• Parameters

  • stats: Stats

  Returns BigIntStats

makeDefaultStats

• makeDefaultStats(): StatEntry

• Returns StatEntry

makeEmptyStats

• makeEmptyStats(): Stats | BigIntStats

• Returns Stats | BigIntStats