@saflib/object-store

---

Abstract Class: ObjectStore

Extended by

• DiskObjectStore
• TestObjectStore

Constructors

Constructor

new ObjectStore(): ObjectStore

Returns

ObjectStore

Methods

deleteFile()

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

Parameters

Parameter	Type
path	string

Returns

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

---

getScopedPath()

protected getScopedPath(path): string

Parameters

Parameter	Type
path	string

Returns

string

---

listFiles()

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

Parameters

Parameter	Type
prefix?	string

Returns

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

---

normalizePath()

protected normalizePath(path): string

Parameters

Parameter	Type
path	string

Returns

string

---

readFile()

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

Parameters

Parameter	Type
path	string

Returns

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

---

uploadFile()

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

Parameters

Parameter	Type
path	string
stream	Readable
metadata?	Record<string, string>

Returns

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

---

upsertContainer()

abstract 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>>

---

validatePath()

protected validatePath(path): string

Parameters

Parameter	Type
path	string

Returns

string