@saflib/object-store

---

Class: TestObjectStore

In-memory ObjectStore for tests. Use setFiles/getFiles to seed or inspect state when testing code that uses an ObjectStore.

Extends

• ObjectStore

Constructors

Constructor

new TestObjectStore(): TestObjectStore

Returns

TestObjectStore

Inherited from

ObjectStore.constructor

Methods

deleteFile()

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

Parameters

Parameter	Type
path	string

Returns

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

Overrides

ObjectStore.deleteFile

---

getFiles()

getFiles(): TestFile[]

Returns

TestFile[]

---

getScopedPath()

getScopedPath(path): string

Exposed for tests that assert path behavior (ObjectStore.test.ts).

Parameters

Parameter	Type
path	string

Returns

string

Overrides

ObjectStore.getScopedPath

---

listFiles()

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

Parameters

Parameter	Type
prefix?	string

Returns

Promise<ReturnsError<object[], StorageError>>

Overrides

ObjectStore.listFiles

---

normalizePath()

normalizePath(path): string

Exposed for tests that assert path behavior (ObjectStore.test.ts).

Parameters

Parameter	Type
path	string

Returns

string

Overrides

ObjectStore.normalizePath

---

readFile()

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

Parameters

Parameter	Type
path	string

Returns

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

Overrides

ObjectStore.readFile

---

setFiles()

setFiles(files): void

Parameters

Parameter	Type
files	TestFile[]

Returns

void

---

uploadFile()

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

Parameters

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

Returns

Promise<ReturnsError<{ success: boolean; url?: string; }, 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()

validatePath(path): string

Exposed for tests that assert path behavior (ObjectStore.test.ts).

Parameters

Parameter	Type
path	string

Returns

string

Overrides

ObjectStore.validatePath