Class Inode

Generic inode definition that can easily be serialized.

Hierarchy

Inode

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Inode(id: string, size: number, mode: number, atime: number, mtime: number, ctime: number): Inode

- Defined in generic/inode.ts:21
Parameters
- id: string
- size: number
- mode: number
- atime: number
- mtime: number
- ctime: number
Returns Inode

Properties

atime

atime: number

ctime

ctime: number

id

id: string

mode

mode: number

mtime

mtime: number

size

size: number

Methods

getSize

getSize(): number

- Defined in generic/inode.ts:42
Get the size of this Inode, in bytes.

Returns number

isDirectory

isDirectory(): boolean

- Defined in generic/inode.ts:116
Returns boolean

True if this item is a directory.

isFile

isFile(): boolean

- Defined in generic/inode.ts:109
Returns boolean

True if this item is a file.

toBuffer

toBuffer(buff?: Buffer): Buffer

- Defined in generic/inode.ts:50
Writes the inode into the start of the buffer.

Parameters
- Default value buff: Buffer = Buffer.alloc(this.getSize())
Returns Buffer

toStats

toStats(): Stats

- Defined in generic/inode.ts:33
Handy function that converts the Inode to a Node Stats object.

Returns Stats

update

update(stats: Stats): boolean

- Defined in generic/inode.ts:70
Updates the Inode using information from the stats object. Used by file systems at sync time, e.g.:
- Program opens file and gets a File object.
- Program mutates file. File object is responsible for maintaining metadata changes locally -- typically in a Stats object.
- Program closes file. File object's metadata changes are synced with the file system.
Parameters
- stats: Stats
Returns boolean

True if any changes have occurred.

Static fromBuffer

fromBuffer(buffer: Buffer): Inode

- Defined in generic/inode.ts:10
Converts the buffer into an Inode.

Parameters
- buffer: Buffer
Returns Inode

Generated using TypeDoc