Class VirtualDriveConfig

Source: virtualDriveConfig.ts

Constructors

Constructor

new VirtualDriveConfig(options: Partial<VirtualDriveConfigOptions>): VirtualDriveConfig

Parameters

options

Partial<VirtualDriveConfigOptions> = {}

Returns

VirtualDriveConfig

Properties

saveData

saveData: false | { enableCompression: boolean; prefix?: string; migrations?: [string, string][]; }

Type Declaration

false

{ enableCompression: boolean; prefix?: string; migrations?: [string, string][]; }

enableCompression

enableCompression: boolean

Enables compression of stored items.

Default

false

prefix?

optional prefix: string

The prefix to prepend to stored keys.

Default

"pos-"

migrations?

optional migrations: [string, string][]

An array of tuples of old and new keys to migrate.

Default

[["data", VirtualDriveStorage.KEY]]

---

defaultData

defaultData: { includePicturesFolder?: boolean; includeDocumentsFolder?: boolean; includeDesktopFolder?: boolean; includeSourceTree?: boolean; includeAppsFolder?: boolean; loadData?: (virtualRoot: VirtualRoot) => void; }

includePicturesFolder?

optional includePicturesFolder: boolean

Include pictures folder in default data.

Default

true

includeDocumentsFolder?

optional includeDocumentsFolder: boolean

Include documents folder in default data.

Default

true

includeDesktopFolder?

optional includeDesktopFolder: boolean

Include desktop folder in default data.

Default

true

includeSourceTree?

optional includeSourceTree: boolean

Include source tree folder in default data.

Default

true

includeAppsFolder?

optional includeAppsFolder: boolean

Include apps folder in default data.

Default

true

loadData()?

optional loadData: (virtualRoot: VirtualRoot) => void

Parameters

virtualRoot

VirtualRoot

Returns

void