ObjectStorageBackend
Defined in: src/persistence/object-storage/ObjectStorageBackend.ts:54
Methods
Section titled “Methods”close()?
Section titled “close()?”
optionalclose():Promise<void>
Defined in: src/persistence/object-storage/ObjectStorageBackend.ts:67
Optional: shut down any underlying client / file handle.
Returns
Section titled “Returns”Promise<void>
delete()
Section titled “delete()”delete(
key):Promise<void>
Defined in: src/persistence/object-storage/ObjectStorageBackend.ts:60
DELETE — idempotent; deleting a non-existent key is a no-op.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
get(
key):Promise<Option<ObjectFetched>>
Defined in: src/persistence/object-storage/ObjectStorageBackend.ts:58
GET — None if the object doesn’t exist.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Option<ObjectFetched>>
list()
Section titled “list()”list(
opts):Promise<ObjectInfo[]>
Defined in: src/persistence/object-storage/ObjectStorageBackend.ts:65
LIST — returns object keys under prefix, sorted ascending by key.
limit is a soft cap, the backend may return fewer entries.
Parameters
Section titled “Parameters”limit?
Section titled “limit?”number
prefix
Section titled “prefix”string
Returns
Section titled “Returns”Promise<ObjectInfo[]>
put(
key,body,opts?):Promise<{etag:string; }>
Defined in: src/persistence/object-storage/ObjectStorageBackend.ts:56
PUT — returns the new ETag. Throws on CAS failure.
Parameters
Section titled “Parameters”string
Uint8Array
Returns
Section titled “Returns”Promise<{ etag: string; }>