Interface StorageAdapter

Portable logical-key storage contract. Missing objects and permission/network failures use distinct typed errors.

interface StorageAdapter {
    delete(key: string, options?: StorageReadOptions): Promise<void>;
    get(key: string, options?: StorageReadOptions): Promise<StorageObject>;
    head(key: string, options?: StorageReadOptions): Promise<StorageObjectInfo>;
    put(
        key: string,
        body: StorageBody,
        options?: StoragePutOptions,
    ): Promise<StorageObjectInfo>;
}

Index

Methods

delete get head put

Methods

delete

delete(key: string, options?: StorageReadOptions): Promise<void>
Idempotently remove a logical key. A missing key succeeds; access/network failures still reject.
Parameters
- key: string
- Optionaloptions: StorageReadOptions
Returns Promise<void>
- Defined in packages/core/src/contracts.ts:377

get

get(key: string, options?: StorageReadOptions): Promise<StorageObject>
Read one object generation and metadata; rejects with STORAGE_NOT_FOUND for a missing key.
Parameters
- key: string
- Optionaloptions: StorageReadOptions
Returns Promise<StorageObject>
- Defined in packages/core/src/contracts.ts:373

head

head(key: string, options?: StorageReadOptions): Promise<StorageObjectInfo>
Read metadata without transferring the body; missing and access/network errors remain distinct.
Parameters
- key: string
- Optionaloptions: StorageReadOptions
Returns Promise<StorageObjectInfo>
- Defined in packages/core/src/contracts.ts:375

put

put(
    key: string,
    body: StorageBody,
    options?: StoragePutOptions,
): Promise<StorageObjectInfo>
Create or replace an object. S3 uses strict multipart; failed pre-completion replacement preserves the old object.
Parameters
- key: string
- body: StorageBody
- Optionaloptions: StoragePutOptions
Returns Promise<StorageObjectInfo>
- Defined in packages/core/src/contracts.ts:371