basalt / storage-s3/src / S3PutStreamOptions
Interface: S3PutStreamOptions
Defined in: storage-s3/src/index.ts:58
What S3StorageDriver.putStream accepts — the shared options plus the multipart knobs.
Extends
Properties
allowedContentTypes?
> optional allowedContentTypes?: readonly string[]
Defined in: storage/src/driver.ts:17
Facade-enforced content-type allowlist. When set, the facade rejects an upload whose contentType is missing or not in this list with STORAGE_CONTENT_TYPE. Opt-in: with no value, any content type is allowed.
Inherited from
PutStreamOptions.allowedContentTypes
contentLength?
> optional contentLength?: number
Defined in: storage/src/driver.ts:38
Exact body size in bytes when the caller knows it. Backends that cannot upload a body of unknown length in one request (S3 PutObject) stream it straight through with it. The Disk layer has already checked it is a non-negative safe integer, and the readable a driver receives errors (STORAGE_CONTENT_LENGTH_MISMATCH) before its end if the body carries more or fewer bytes — a driver may declare it to its backend as-is.
Inherited from
PutStreamOptions.contentLength
contentType?
> optional contentType?: string
Defined in: storage/src/driver.ts:4
Inherited from
maxBytes?
> optional maxBytes?: number
Defined in: storage/src/driver.ts:11
Facade-enforced upload cap. When set, the facade rejects content larger than this many bytes with STORAGE_TOO_LARGE before delegating to the driver. Enforced for Buffer/string inputs, whose byte length is known up front. Opt-in: with no value, uploads are uncapped as before.
Inherited from
partSizeBytes?
> optional partSizeBytes?: number
Defined in: storage-s3/src/index.ts:52
Bytes per part. Defaults to 5 MiB — S3's minimum for every part but the last, and therefore the lowest value accepted. Larger parts mean fewer requests and more memory: up to partSizeBytes × queueSize is in flight.
Inherited from
S3MultipartOptions.partSizeBytes
queueSize?
> optional queueSize?: number
Defined in: storage-s3/src/index.ts:54
Parts uploaded in parallel. Defaults to 4. Must be at least 1.