SudoSOS Back-end API / internal/files/storage / DiskStorage

Class: DiskStorage

Implements

• FileStorage

Constructors

Constructor

new DiskStorage(workdir): DiskStorage;

Parameters

Parameter	Type
workdir	string

Returns

DiskStorage

Methods

deleteFile()

deleteFile(file): Promise<boolean>;

Delete the file from the storage system

Parameters

Parameter	Type
file	BaseFile

Returns

Promise<boolean>

true when file was deleted, false when file does not exist in storage

Throws

Error when file could not be deleted

Implementation of

FileStorage.deleteFile

---

getFile()

getFile(file): Promise<Buffer<ArrayBufferLike>>;

Get the file from storage as a buffer object

Parameters

Parameter	Type
file	BaseFile

Returns

Promise<Buffer<ArrayBufferLike>>

Throws

Error when file could not be found in storage

Implementation of

FileStorage.getFile

---

saveFile()

saveFile(fileName, fileData): Promise<string>;

Save a file with the given name to storage

Parameters

Parameter	Type
fileName	string
fileData	Buffer

Returns

Promise<string>

The location of the file

Implementation of

FileStorage.saveFile

---

validateFileLocation()

validateFileLocation(location): void;

Parameters

Parameter	Type
location	string

Returns

void