Class VirtualFolderLink

Source: virtualFolderLink.ts

A link that points to a virtual folder.

Extends

• VirtualFolder

Constructors

Constructor

new VirtualFolderLink(name: string, linkedFolder?: VirtualFolder<VirtualBaseEvents>): VirtualFolderLink

Parameters

name

string

linkedFolder?

VirtualFolder<VirtualBaseEvents>

Returns

VirtualFolderLink

Overrides

VirtualFolder.constructor

Properties

subFolders

subFolders: (VirtualFolder<VirtualBaseEvents> | VirtualFolderLink)[]

The folders inside this folder.

Inherited from

VirtualFolder.subFolders

---

files

files: (VirtualFile | VirtualFileLink)[]

The files inside this folder.

Inherited from

VirtualFolder.files

---

type

type: number | undefined

The type of this folder.

Default

VirtualFolder.TYPE.general

Inherited from

VirtualFolder.type

---

TYPE

static TYPE: { general: number; media: number; }

general

general: number = 0

media

media: number = 1

Inherited from

VirtualFolder.TYPE

---

linkedPath?

optional linkedPath: string

---

name

name: string

The name of this item.

Inherited from

VirtualFolder.name

---

alias

alias: string | null | undefined

The alias of this item.

Inherited from

VirtualFolder.alias

---

parent

parent: VirtualFolder<VirtualBaseEvents> | null | undefined

The folder this item is in.

Inherited from

VirtualFolder.parent

---

isProtected

isProtected: boolean | null | undefined

Whether this item is protected from changes.

Inherited from

VirtualFolder.isProtected

---

iconUrl

iconUrl: string | null | undefined

The URL of the icon of this item.

Inherited from

VirtualFolder.iconUrl

---

linkedFile

linkedFile: VirtualFile | null | undefined

The file this item links to.

Inherited from

VirtualFolder.linkedFile

---

linkedFolder

linkedFolder: VirtualFolder<VirtualBaseEvents> | null | undefined

The folder this item links to.

Inherited from

VirtualFolder.linkedFolder

---

editedByUser

editedByUser: boolean | null | undefined

Whether this item has been edited by the user.

Inherited from

VirtualFolder.editedByUser

---

isRoot

isRoot: boolean | null | undefined

Whether this item is the root folder.

Inherited from

VirtualFolder.isRoot

---

root

root: VirtualRoot | null | undefined

The root folder.

Inherited from

VirtualFolder.root

---

isDeleted

isDeleted: boolean

Whether this item has been deleted.

Inherited from

VirtualFolder.isDeleted

---

UPDATE_EVENT

readonly static UPDATE_EVENT: "update" = "update"

Inherited from

VirtualFolder.UPDATE_EVENT

Methods

addFile()

addFile(file: VirtualFile, confirmChanges: boolean): this

Parameters

file

VirtualFile

confirmChanges

boolean = true

Returns

this

Inherited from

VirtualFolder.addFile

---

createFileLink()

createFileLink(name: string, callback?: (newFileLink: VirtualFile | VirtualFileLink) => void): this

Creates a file link with a name.

Parameters

name

string

callback?

(newFileLink: VirtualFile | VirtualFileLink) => void

Returns

this

Inherited from

VirtualFolder.createFileLink

---

createFileLinks()

createFileLinks(fileLinks: { name: string; }[]): this

Creates file links based on an array of objects with file names and extensions.

Parameters

fileLinks

{ name: string; }[]

Returns

this

Inherited from

VirtualFolder.createFileLinks

---

addFolder()

addFolder(folder: VirtualFolder, confirmChanges: boolean): this

Parameters

folder

VirtualFolder

confirmChanges

boolean = true

Returns

this

Inherited from

VirtualFolder.addFolder

---

createFolderLink()

createFolderLink(name: string, callback?: (newFolderLink: VirtualFolder<VirtualBaseEvents> | VirtualFolderLink) => void): this

Creates a folder link with a name.

Parameters

name

string

callback?

(newFolderLink: VirtualFolder<VirtualBaseEvents> | VirtualFolderLink) => void

Returns

this

Inherited from

VirtualFolder.createFolderLink

---

createFolderLinks()

createFolderLinks(names: string[]): this

Creates folder links based on an array of folder names.

Parameters

names

string[]

Returns

this

Inherited from

VirtualFolder.createFolderLinks

---

remove()

remove(child: VirtualFolder<VirtualBaseEvents> | VirtualFile | VirtualFileLink | VirtualFolderLink): this

Removes a file or folder from this folder.

Parameters

child

VirtualFolder<VirtualBaseEvents> | VirtualFile | VirtualFileLink | VirtualFolderLink

Returns

this

Inherited from

VirtualFolder.remove

---

navigate()

navigate(relativePath: string): VirtualFolder<VirtualBaseEvents> | VirtualFile | null

Returns the file or folder at a relative path or null if it doesn't exist.

Parameters

relativePath

string

Returns

VirtualFolder<VirtualBaseEvents> | VirtualFile | null

Inherited from

VirtualFolder.navigate

---

delete()

delete(): void

Deletes this folder and all its files and sub-folders recursively.

Returns

void

Inherited from

VirtualFolder.delete

---

isFolder()

isFolder(): this is VirtualFolder<VirtualBaseEvents>

Returns

this is VirtualFolder<VirtualBaseEvents>

Inherited from

VirtualFolder.isFolder

---

setLinkedFolder()

setLinkedFolder(folder: VirtualFolder): VirtualFolderLink

Parameters

folder

VirtualFolder

Returns

VirtualFolderLink

---

setLinkedPath()

setLinkedPath(path: string): VirtualFolderLink

Parameters

path

string

Returns

VirtualFolderLink

---

isValid()

isValid(): boolean

Returns

boolean

---

getIconUrl()

getIconUrl(): string

Returns

string

Overrides

VirtualFolder.getIconUrl

---

toJSON()

toJSON(): VirtualFolderLinkJson | null

Returns

VirtualFolderLinkJson | null

Overrides

VirtualFolder.toJSON

---

setAlias()

setAlias(...args: [string]): VirtualFolderLink

Parameters

args

...[string]

Returns

VirtualFolderLink

Overrides

VirtualFolder.setAlias

---

createFile()

createFile(...args: [string, string, (newFile: VirtualFile | VirtualFileLink) => void]): VirtualFolderLink

Creates a file with a name and extension.

Parameters

args

...[string, string, (newFile: VirtualFile | VirtualFileLink) => void]

Returns

VirtualFolderLink

Overrides

VirtualFolder.createFile

---

createFiles()

createFiles(...args: [{ name: string; extension: string; }[]]): VirtualFolderLink

Creates files based on an array of objects with file names and extensions.

Parameters

args

...[{ name: string; extension: string; }[]]

Returns

VirtualFolderLink

Overrides

VirtualFolder.createFiles

---

createFolder()

createFolder(...args: [string, (newFolder: VirtualFolder) => void]): VirtualFolderLink

Creates a folder with a name.

Parameters

args

...[string, (newFolder: VirtualFolder) => void]

Returns

VirtualFolderLink

Overrides

VirtualFolder.createFolder

---

createFolders()

createFolders(...args: [string[]]): VirtualFolderLink

Creates folders based on an array of folder names.

Parameters

args

...[string[]]

Returns

VirtualFolderLink

Overrides

VirtualFolder.createFolders

---

hasFile()

hasFile(...args: [string, string]): boolean

Returns true if this folder contains a file matching a name and extension.

Parameters

args

...[string, string]

Returns

boolean

Overrides

VirtualFolder.hasFile

---

hasFolder()

hasFolder(...args: [string]): boolean

Returns true if this folder contains a folder matching a name.

Parameters

args

...[string]

Returns

boolean

Overrides

VirtualFolder.hasFolder

---

findFile()

findFile(...args: [string, string | null]): VirtualFile | VirtualFileLink | null

Finds and returns a file inside this folder matching a name and extension.

Parameters

args

...[string, string | null]

Returns

VirtualFile | VirtualFileLink | null

Overrides

VirtualFolder.findFile

---

findSubFolder()

findSubFolder(...args: [string]): VirtualFolder<VirtualBaseEvents> | VirtualFolderLink | null

Finds and returns a folder inside this folder matching a name.

Parameters

args

...[string]

Returns

VirtualFolder<VirtualBaseEvents> | VirtualFolderLink | null

Overrides

VirtualFolder.findSubFolder

---

getFiles()

getFiles(...args: [boolean]): VirtualFile[]

Returns all files inside this folder.

Parameters

args

...[boolean]

Returns

VirtualFile[]

Overrides

VirtualFolder.getFiles

---

getSubFolders()

getSubFolders(...args: [boolean]): VirtualFolder<VirtualBaseEvents>[]

Returns all sub-folders inside this folder.

Parameters

args

...[boolean]

Returns

VirtualFolder<VirtualBaseEvents>[]

Overrides

VirtualFolder.getSubFolders

---

open()

open(...args: [WindowsManager]): object | null | undefined

Opens this folder in file explorer.

Parameters

args

...[WindowsManager]

Returns

object | null | undefined

Overrides

VirtualFolder.open

---

getItemCount()

getItemCount(...args: [boolean]): number

Returns the amount of files and sub-folders inside this folder.

Parameters

args

...[boolean]

Returns

number

Overrides

VirtualFolder.getItemCount

---

setName()

setName(name: string): this

Parameters

name

string

Returns

this

Inherited from

VirtualFolder.setName

---

setParent()

setParent(parent: VirtualFolder): this

Parameters

parent

VirtualFolder

Returns

this

Inherited from

VirtualFolder.setParent

---

setProtected()

setProtected(value: boolean): this

Parameters

value

boolean

Returns

this

Inherited from

VirtualFolder.setProtected

---

setIconUrl()

setIconUrl(iconUrl: string | null): this

Parameters

iconUrl

string | null

Returns

this

Inherited from

VirtualFolder.setIconUrl

---

getType()

getType(): string

Returns

string

Inherited from

VirtualFolder.getType

---

confirmChanges()

confirmChanges(root?: VirtualRoot): void

Parameters

root?

VirtualRoot

Returns

void

Inherited from

VirtualFolder.confirmChanges

---

getRoot()

getRoot(): VirtualRoot

Returns the root folder.

Returns

VirtualRoot

Inherited from

VirtualFolder.getRoot

---

isFile()

isFile(): this is VirtualFile

Returns

this is VirtualFile

Inherited from

VirtualFolder.isFile

---

toString()

toString(): string | null

Returns a string representation of an object.

Returns

string | null

Inherited from

VirtualFolder.toString

---

on()

on<K>(event: K, listener: Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>): Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

Starts listening to an event.

Type Parameters

K

K extends "update"

Parameters

event

K

The event to listen to.

listener

Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The function to call when the event is emitted.

Returns

Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The listener.

Inherited from

VirtualFolder.on

---

once()

once<K>(event: K, listener: Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>): Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

Registers an event listener that is automatically removed when called.

Type Parameters

K

K extends "update"

Parameters

event

K

The event to listen to.

listener

Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The function to call once the event is emitted.

Returns

Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The wrapped listener.

Inherited from

VirtualFolder.once

---

onAsync()

onAsync<K>(event: K, listener: AsyncListener<VirtualBaseEvents & Record<"update", unknown[]>, K>, onRejected?: (reason: any) => unknown | null): Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

Starts listening to an event.

Type Parameters

K

K extends "update"

Parameters

event

K

The event to listen to.

listener

AsyncListener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The function to call when the event is emitted.

onRejected?

(reason: any) => unknown | null

Returns

Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The wrapped listener.

Inherited from

VirtualFolder.onAsync

---

off()

off<K>(event: K, listener: Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>): void

Removes an event listener.

Type Parameters

K

K extends "update"

Parameters

event

K

The event to remove the listener from.

listener

Listener<VirtualBaseEvents & Record<"update", unknown[]>, K>

The listener to remove.

Returns

void

Inherited from

VirtualFolder.off

---

emit()

emit<K>(event: K, ...args: VirtualBaseEvents & Record<"update", unknown[]>[K]): void

Emits an event to all its listeners.

Type Parameters

K

K extends "update"

Parameters

event

K

The event to emit.

args

...VirtualBaseEvents & Record<"update", unknown[]>[K]

The arguments to pass to the listeners.

Returns

void

Inherited from

VirtualFolder.emit

Accessors

id

Get Signature

get id(): string

Returns

string

Inherited from

VirtualFolder.id

---

path

Get Signature

get path(): string

Returns the path of this item.

Returns

string

Inherited from

VirtualFolder.path

---

displayPath

Get Signature

get displayPath(): string

Returns path without using this item's alias.

Returns

string

Inherited from

VirtualFolder.displayPath

---

absolutePath

Get Signature

get absolutePath(): string

Returns path without using any aliases.

Returns

string

Inherited from

VirtualFolder.absolutePath

---

canBeEdited

Get Signature

get canBeEdited(): boolean

Returns whether this can be edited in its current state.

Returns

boolean

Inherited from

VirtualFolder.canBeEdited