FileSystemAdapter

Implementation of the vault adapter for desktop.

Extends

• DataAdapter

Implements

• DataAdapter

Constructors

new FileSystemAdapter()

new FileSystemAdapter(): FileSystemAdapter

Returns

FileSystemAdapter

Properties

basePath

basePath: string

Base OS path for the vault (e.g. /home/user/vault, or C:\Users\user\documents\vault)

Implementation of

DataAdapter.basePath

Inherited from

DataAdapter.basePath

---

files

files: DataAdapterFilesRecord

Mapping of file/folder path to vault entry, includes non-MD files

Implementation of

DataAdapter.files

Inherited from

DataAdapter.files

---

fs

fs: __module

Reference to node fs module

---

fsPromises

fsPromises: __module

Reference to node fs:promises module

---

ipcRenderer?

optional ipcRenderer: IpcRenderer

Reference to electron ipcRenderer module

---

path

path: PlatformPath

Reference to node path module

---

url

url: URL

Reference to node URL module

Methods

append()

append(normalizedPath, data, options?): Promise<void>

Parameters

• normalizedPath: string

• data: string

• options?: DataWriteOptions

Returns

Promise<void>

Implementation of

DataAdapter.append

Inherited from

DataAdapter.append

---

copy()

copy(normalizedPath, normalizedNewPath): Promise<void>

Parameters

• normalizedPath: string

• normalizedNewPath: string

Returns

Promise<void>

Implementation of

DataAdapter.copy

Inherited from

DataAdapter.copy

---

exists()

exists(normalizedPath, sensitive?): Promise<boolean>

Parameters

• normalizedPath: string

• sensitive?: boolean

Returns

Promise<boolean>

Implementation of

DataAdapter.exists

Inherited from

DataAdapter.exists

---

getBasePath()

getBasePath()

getBasePath(): string

Returns

string

getBasePath()

getBasePath(): string

Get base path of vault (OS path)

Returns

string

---

getFilePath()

getFilePath(normalizedPath)

getFilePath(normalizedPath): string

Returns the file:// path of this file

Parameters

• normalizedPath: string

Returns

string

getFilePath(normalizedPath)

getFilePath(normalizedPath): string

Get full path of file (OS path)

Parameters

• normalizedPath: string

Path to file

Returns

string

URL path to file

---

getFullPath()

getFullPath(normalizedPath): string

Parameters

• normalizedPath: string

Returns

string

Implementation of

DataAdapter.getFullPath

Inherited from

DataAdapter.getFullPath

---

getFullRealPath()

getFullRealPath(normalizedPath): string

Get full path of file (OS path)

Parameters

• normalizedPath: string

Path to file

Returns

string

String full path to file

Implementation of

DataAdapter.getFullRealPath

Inherited from

DataAdapter.getFullRealPath

---

getName()

getName(): string

Returns

string

Implementation of

DataAdapter.getName

Inherited from

DataAdapter.getName

---

getResourcePath()

getResourcePath(normalizedPath): string

Parameters

• normalizedPath: string

Returns

string

Implementation of

DataAdapter.getResourcePath

Inherited from

DataAdapter.getResourcePath

---

list()

list(normalizedPath): Promise<ListedFiles>

Parameters

• normalizedPath: string

Returns

Promise<ListedFiles>

Implementation of

DataAdapter.list

Inherited from

DataAdapter.list

---

mkdir()

mkdir(normalizedPath): Promise<void>

Parameters

• normalizedPath: string

Returns

Promise<void>

Implementation of

DataAdapter.mkdir

Inherited from

DataAdapter.mkdir

---

process()

process(normalizedPath, fn, options?): Promise<string>

Parameters

• normalizedPath: string

• fn

• options?: DataWriteOptions

Returns

Promise<string>

Implementation of

DataAdapter.process

Inherited from

DataAdapter.process

---

queue()

queue(next): Promise<void>

Parameters

• next

Returns

Promise<void>

Implementation of

DataAdapter.queue

Inherited from

DataAdapter.queue

---

read()

read(normalizedPath): Promise<string>

Parameters

• normalizedPath: string

Returns

Promise<string>

Implementation of

DataAdapter.read

Inherited from

DataAdapter.read

---

readBinary()

readBinary(normalizedPath): Promise<ArrayBuffer>

Parameters

• normalizedPath: string

Returns

Promise<ArrayBuffer>

Implementation of

DataAdapter.readBinary

Inherited from

DataAdapter.readBinary

---

remove()

remove(normalizedPath): Promise<void>

Parameters

• normalizedPath: string

Returns

Promise<void>

Implementation of

DataAdapter.remove

Inherited from

DataAdapter.remove

---

rename()

rename(normalizedPath, normalizedNewPath): Promise<void>

Parameters

• normalizedPath: string

• normalizedNewPath: string

Returns

Promise<void>

Implementation of

DataAdapter.rename

Inherited from

DataAdapter.rename

---

rmdir()

rmdir(normalizedPath, recursive): Promise<void>

Parameters

• normalizedPath: string

• recursive: boolean

Returns

Promise<void>

Implementation of

DataAdapter.rmdir

Inherited from

DataAdapter.rmdir

---

stat()

stat(normalizedPath): Promise<null | Stat>

Parameters

• normalizedPath: string

Returns

Promise<null | Stat>

Implementation of

DataAdapter.stat

Inherited from

DataAdapter.stat

---

trashLocal()

trashLocal(normalizedPath): Promise<void>

Parameters

• normalizedPath: string

Returns

Promise<void>

Implementation of

DataAdapter.trashLocal

Inherited from

DataAdapter.trashLocal

---

trashSystem()

trashSystem(normalizedPath): Promise<boolean>

Parameters

• normalizedPath: string

Returns

Promise<boolean>

Implementation of

DataAdapter.trashSystem

Inherited from

DataAdapter.trashSystem

---

write()

write(normalizedPath, data, options?): Promise<void>

Parameters

• normalizedPath: string

• data: string

• options?: DataWriteOptions

Returns

Promise<void>

Implementation of

DataAdapter.write

Inherited from

DataAdapter.write

---

writeBinary()

writeBinary(normalizedPath, data, options?): Promise<void>

Parameters

• normalizedPath: string

• data: ArrayBuffer

• options?: DataWriteOptions

Returns

Promise<void>

Implementation of

DataAdapter.writeBinary

Inherited from

DataAdapter.writeBinary

---

mkdir()

static mkdir(path): Promise<void>

Parameters

• path: string

Returns

Promise<void>

---

readLocalFile()

static readLocalFile(path): Promise<ArrayBuffer>

Parameters

• path: string

Returns

Promise<ArrayBuffer>