Class IndexDirInode<T>

Inode for a directory. Currently only contains the directory listing.

Type Parameters

T

Hierarchy

IndexDirInode

Implements

IndexInode

Index

Constructors

Properties

Methods

addItem getData getItem getListing getStats isDir isFile remItem toStats

Constructors

constructor

new IndexDirInode<T>(data?): IndexDirInode<T>
Constructs an inode for a directory.
Type Parameters
- T
Parameters
- data: T = null
Returns IndexDirInode<T>
- Defined in src/FileIndex.ts:288

Properties

`Private` _ls

_ls: {
[path: string]: IndexInode;
} = {}

Type declaration

[path: string]: IndexInode

`Private` data

data: T = null

Methods

addItem

addItem(p, inode): boolean
Add the given item to the directory listing. Note that the given inode is not copied, and will be mutated by the DirInode if it is a DirInode.
Parameters
- p: string
  
  Item name to add to the directory listing.
- inode: IndexInode
  
  The inode for the item to add to the directory inode.
Returns boolean
True if it was added, false if it already existed.
- Defined in src/FileIndex.ts:339

getData

getData(): T
Returns T
- Defined in src/FileIndex.ts:295

getItem

getItem(p): IndexInode
Returns the inode for the indicated item, or null if it does not exist.
Parameters
- p: string
  
  Name of item in this directory.
Returns IndexInode
- Defined in src/FileIndex.ts:327

getListing

getListing(): string[]
Returns the directory listing for this directory. Paths in the directory are relative to the directory's path.

Returns string[]
The directory listing for this directory.
- Defined in src/FileIndex.ts:320

getStats

getStats(): Stats
Return a Stats object for this inode.

Returns Stats

Todo
Should probably remove this at some point. This isn't the responsibility of the FileIndex.
- Defined in src/FileIndex.ts:304

isDir

isDir(): boolean
Returns boolean
Implementation of IndexInode.isDir
- Defined in src/FileIndex.ts:292

isFile

isFile(): boolean
Returns boolean
Implementation of IndexInode.isFile
- Defined in src/FileIndex.ts:289

remItem

remItem(p): IndexInode
Removes the given item from the directory listing.
Parameters
- p: string
  
  Name of item to remove from the directory listing.
Returns IndexInode
Returns the item removed, or null if the item did not exist.
- Defined in src/FileIndex.ts:352

toStats

toStats(): Stats
Alias of getStats()

Returns Stats

Todo
Remove this at some point. This isn't the responsibility of the FileIndex.
Implementation of IndexInode.toStats
- Defined in src/FileIndex.ts:312

Generated using TypeDoc