Class VirtualBase extends EventEmitter

Constructor

new VirtualBase(name)

Parameters

• name
  • Type: string

Properties

id

• Type: string

name

• Type: string

alias

• Type: string | undefined

parent

• Type: VirtualFolder | undefined

References

• VirtualFolder

isProtected

• Type: boolean | undefined

iconUrl

• Type: string | undefined

linkedFile

• Type: VirtualFile | undefined

linkedFolder

• Type: VirtualFolder | undefined

References

• VirtualFolder

editedByUser

• Type: boolean | undefined

isRoot

• Type: boolean | undefined

root

• Type: VirtualRoot | undefined

path

• Type: string

displayPath

Returns path without using this item's alias

• Type: string

absolutePath

Returns path without using any aliases

• Type: string

canBeEdited

Returns whether this can be edited in its current state

• Type: boolean

Methods

setName(name)

• Parameters
  • name
    • Type: string
• Returns: this

setAlias(alias)

• Parameters
  • alias
    • Type: string
• Returns: this

setParent(parent)

• Parameters
  • parent
    • Type: VirtualFolder
• Returns: this

setProtected(value)

• Parameters
  • value
    • Type: boolean
• Returns: this

setIconUrl(iconUrl)

• Parameters
  • iconUrl
    • Type: string | null
• Returns: this

getIconUrl()

• Returns
  • Type: string

getType()

• Returns: "None"

delete()

confirmChanges(root)

• Parameters
  • root
    • Type: VirtualRoot | undefined

open(...args)

• Parameters
  • args
    • Type: unknown[]
• Returns: null

getRoot()

• Returns
  • Type: VirtualRoot

isFile()

• Returns: false
  • Type: boolean

isFolder()

• Returns: false
  • Type: boolean

toJSON()

• Returns
  • Type: VirtualBaseJson | null

interface VirtualBaseJson {
	nam: string;
	ico?: string;
}

toString()

• Returns
  • Type: string | null