FilesystemObjectStorageBackend
Defined in: src/persistence/object-storage/FilesystemObjectStorageBackend.ts:116
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FilesystemObjectStorageBackend(
options):FilesystemObjectStorageBackend
Defined in: src/persistence/object-storage/FilesystemObjectStorageBackend.ts:121
Parameters
Section titled “Parameters”options
Section titled “options”FilesystemObjectStorageOptions
Returns
Section titled “Returns”FilesystemObjectStorageBackend
Methods
Section titled “Methods”close()
Section titled “close()”close():
Promise<void>
Defined in: src/persistence/object-storage/FilesystemObjectStorageBackend.ts:301
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/FilesystemObjectStorageBackend.ts:239
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/FilesystemObjectStorageBackend.ts:208
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(
options):Promise<ObjectInfo[]>
Defined in: src/persistence/object-storage/FilesystemObjectStorageBackend.ts:263
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”options
Section titled “options”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,options?):Promise<{etag:string; }>
Defined in: src/persistence/object-storage/FilesystemObjectStorageBackend.ts:129
PUT — returns the new ETag. Throws on CAS failure.
Parameters
Section titled “Parameters”string
Uint8Array
options?
Section titled “options?”PutOptions = {}
Returns
Section titled “Returns”Promise<{ etag: string; }>