@saflib/object-store

---

Class: DiskObjectStore

Extends

• ObjectStore

Constructors

Constructor

new DiskObjectStore(rootPath): DiskObjectStore

Parameters

Parameter	Type
rootPath	string

Returns

DiskObjectStore

Overrides

ObjectStore.constructor

Methods

deleteFile()

deleteFile(relativePath): Promise<ReturnsError<{ success: boolean; }, PathTraversalError | StorageError>>>>

Parameters

Parameter	Type
relativePath	string

Returns

Promise<ReturnsError<{ success: boolean; }, PathTraversalError | StorageError>>

Overrides

ObjectStore.deleteFile

---

getScopedPath()

protected getScopedPath(path): string

Parameters

Parameter	Type
path	string

Returns

string

Inherited from

ObjectStore.getScopedPath

---

listFiles()

listFiles(prefix?): Promise<ReturnsError<object[], PathTraversalError | StorageError>>>>

Parameters

Parameter	Type
prefix?	string

Returns

Promise<ReturnsError<object[], PathTraversalError | StorageError>>

Overrides

ObjectStore.listFiles

---

normalizePath()

protected normalizePath(path): string

Parameters

Parameter	Type
path	string

Returns

string

Inherited from

ObjectStore.normalizePath

---

readFile()

readFile(relativePath): Promise<ReturnsError<Readable, PathTraversalError | StorageError | FileNotFoundError>>>>

Parameters

Parameter	Type
relativePath	string

Returns

Promise<ReturnsError<Readable, PathTraversalError | StorageError | FileNotFoundError>>

Overrides

ObjectStore.readFile

---

uploadFile()

uploadFile(relativePath, stream, _metadata?): Promise<ReturnsError<{ success: boolean; url?: string; }, PathTraversalError | StorageError>>>>

Parameters

Parameter	Type
relativePath	string
stream	Readable
_metadata?	Record<string, string>

Returns

Promise<ReturnsError<{ success: boolean; url?: string; }, PathTraversalError | StorageError>>

Overrides

ObjectStore.uploadFile

---

upsertContainer()

upsertContainer(): Promise<ReturnsError<{ created?: boolean; skipped?: boolean; success: boolean; updated?: boolean; url?: string; }, StorageError>>>>

Returns

Promise<ReturnsError<{ created?: boolean; skipped?: boolean; success: boolean; updated?: boolean; url?: string; }, StorageError>>

Overrides

ObjectStore.upsertContainer

---

validatePath()

protected validatePath(path): string

Parameters

Parameter	Type
path	string

Returns

string

Inherited from

ObjectStore.validatePath