S3ObjectStorageBackend
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:78
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new S3ObjectStorageBackend(
options):S3ObjectStorageBackend
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:82
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”S3ObjectStorageBackend
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:200
Optional: shut down any underlying client / file handle.
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”delete()
Section titled “delete()”delete(
key):Promise<void>
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:152
DELETE — idempotent; deleting a non-existent key is a no-op.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<void>
Implementation of
Section titled “Implementation of”get(
key):Promise<Option<ObjectFetched>>
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:127
GET — None if the object doesn’t exist.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Option<ObjectFetched>>
Implementation of
Section titled “Implementation of”list()
Section titled “list()”list(
opts):Promise<ObjectInfo[]>
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:164
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[]>
Implementation of
Section titled “Implementation of”put(
key,body,opts?):Promise<{etag:string; }>
Defined in: src/persistence/object-storage/S3ObjectStorageBackend.ts:96
PUT — returns the new ETag. Throws on CAS failure.
Parameters
Section titled “Parameters”string
Uint8Array
PutOptions = {}
Returns
Section titled “Returns”Promise<{ etag: string; }>