Interface StoragePutOptions

Metadata, length validation, cancellation and progress for a storage write.

interface StoragePutOptions {
    contentLength?: number;
    contentType?: string;
    metadata?: Readonly<Record<string, string>>;
    onProgress?: (progress: StorageProgress) => void;
    signal?: AbortSignal;
}

Properties

contentLength?: number

Expected byte length. A mismatch rejects before successful publication.

contentType?: string

Persisted MIME type; at most 255 printable ASCII characters.

metadata?: Readonly<Record<string, string>>

Portable lowercase ASCII keys (≤64 chars) and printable ASCII values; combined maximum 2048 bytes.

onProgress?: (progress: StorageProgress) => void

Receives byte progress. Retries do not count bytes a second time.

signal?: AbortSignal

Cancels reading/uploading and requests cleanup; commit uncertainty is reported separately.