NodeFileSystemAdapter

NodeFileSystemAdapter implements LocalStorageAdapter using Node.js filesystem. Suitable for Node.js environments and Electron applications.

Implements

• LocalStorageAdapter

Constructors

new NodeFileSystemAdapter()

new NodeFileSystemAdapter(storageDirectory): NodeFileSystemAdapter

Parameters

Parameter	Type	Default value
storageDirectory	string	'./user_data'

Returns

NodeFileSystemAdapter

Methods

clear()

clear(): Promise<void>

Returns

Promise<void>

Implementation of

LocalStorageAdapter.clear

---

deleteFile()

deleteFile(path, options?): Promise<void>

Parameters

Parameter	Type
path	string
options?	{ filename: string; }
options.filename?	string

Returns

Promise<void>

Implementation of

LocalStorageAdapter.deleteFile

---

downloadFile()

downloadFile(filePath): Promise<Blob>

Parameters

Parameter	Type
filePath	string

Returns

Promise<Blob>

---

fileExists()

fileExists(filePath): Promise<boolean>

Parameters

Parameter	Type	Description
filePath	string	Path where the file is stored

Returns

Promise<boolean>

True if the file exists, false otherwise

Implementation of

LocalStorageAdapter.fileExists

---

getLocalUri()

getLocalUri(filename): string

Parameters

Parameter	Type	Description
filename	string	The filename to get the path for

Returns

string

The full file path

Implementation of

LocalStorageAdapter.getLocalUri

---

initialize()

initialize(): Promise<void>

Returns

Promise<void>

Implementation of

LocalStorageAdapter.initialize

---

makeDir()

makeDir(path): Promise<void>

Parameters

Parameter	Type	Description
path	string	The full path to the directory

Returns

Promise<void>

Implementation of

LocalStorageAdapter.makeDir

---

readFile()

readFile(filePath, options?): Promise<ArrayBuffer>

Parameters

Parameter	Type	Description
filePath	string	Path where the file is stored
options?	{ encoding: EncodingType; mediaType: string; }	-
options.encoding?	EncodingType	-
options.mediaType?	string	-

Returns

Promise<ArrayBuffer>

ArrayBuffer containing the file data

Implementation of

LocalStorageAdapter.readFile

---

rmDir()

rmDir(path): Promise<void>

Parameters

Parameter	Type	Description
path	string	The full path to the directory

Returns

Promise<void>

Implementation of

LocalStorageAdapter.rmDir

---

saveFile()

saveFile(
   filePath, 
   data, 
options?): Promise<number>

Parameters

Parameter	Type	Description
filePath	string	Path where the file will be stored
data	AttachmentData	Data to store (ArrayBuffer, Blob, or string)
options?	{ encoding: EncodingType; mediaType: string; }	-
options.encoding?	EncodingType	-
options.mediaType?	string	-

Returns

Promise<number>

Number of bytes written

Implementation of

LocalStorageAdapter.saveFile

---

uploadFile()

uploadFile(
   filePath, 
   data, 
options?): Promise<void>

Parameters

Parameter	Type
filePath	string
data	ArrayBuffer
options?	{ encoding: EncodingType; }
options.encoding?	EncodingType

Returns

Promise<void>