FileEntry | aspen-core

Hierarchy

FileEntry
- Directory

Index

Properties

nextId

Accessors

Methods

Properties

Static nextId

nextId: (Anonymous function) = (() => {let id = 0return () => id++})()

Accessors

depth

depth:

Hierarchial depth of this item relative to the Root

disposed

disposed:

disposed status of this item

Once an item is disposed, it's best to let go of all references to it to avoid any memory leaks

fileName

fileName:

id

id:

parent

parent:

path

path:

Full absolute path of this item

root

root:

type

type:

Methods

addMetadata

addMetadata(withKey: string, value: any): void

- Defined in FileEntry.ts:129
Parameters
- withKey: string
- value: any
Returns void

getMetadata

getMetadata(withKey: string): any

- Defined in FileEntry.ts:125
Parameters
- withKey: string
Returns any

mv

mv(to: Directory, fname?: string): void

- Defined in FileEntry.ts:93
Very much like unixs mv command

Calling this method directly WILL NOT trigger onWillHandleWatchEvent and onDidHandleWatchEvent events

Prefer using Root#inotify instead

Parameters
- to: Directory
- Default value fname: string = this.fileName
Returns void

removeMetadata

removeMetadata(withKey: string): void

- Defined in FileEntry.ts:140
Parameters
- withKey: string
Returns void

Static checkRawFile

checkRawFile(file: IFileEntryItem): void

- Defined in FileEntry.ts:11
Parameters
- file: IFileEntryItem
Returns void

Static getFileEntryById

getFileEntryById(id: number): FileEntry

- Defined in FileEntry.ts:23
Parameters
- id: number
Returns FileEntry

Generated using TypeDoc