API ReferenceinterfacesUsemultipleuploadoptions

upload-with-progress


Defined in: src/browser/useMultipleUpload.ts:18

Configuration options accepted by useMultipleUpload.

Extends

Properties

allowedTypes?

optional allowedTypes: string[]

Defined in: src/browser/core.ts:54

Allowed MIME types (e.g. ["image/png", "image/jpeg"]). Supports wildcard subtypes such as "image/*".

Default

undefined — all types allowed

Inherited from

UploadCoreOptions.allowedTypes


concurrency?

optional concurrency: number

Defined in: src/browser/useMultipleUpload.ts:24

Maximum number of files uploaded concurrently. For example, concurrency: 3 uploads at most 3 files at a time.

Default

Infinity — all files start immediately

headers?

optional headers: Record<string, string>

Defined in: src/browser/core.ts:81

Extra headers to send with the PUT request. Content-Type is set automatically from the file’s MIME type unless you provide an explicit Content-Type key here.

Inherited from

UploadCoreOptions.headers


maxFileSize?

optional maxFileSize: number

Defined in: src/browser/core.ts:47

Maximum allowed file size in bytes.

Default

Infinity

Inherited from

UploadCoreOptions.maxFileSize


retries?

optional retries: number

Defined in: src/browser/core.ts:67

Number of automatic retries on transient failures: network errors, timeouts, HTTP 429, and HTTP 5xx.

Default

0

Inherited from

UploadCoreOptions.retries


retryDelay?

optional retryDelay: number

Defined in: src/browser/core.ts:74

Base delay in ms for exponential back-off between retries. Actual delay = retryDelay × 2^attempt (capped at 30 s).

Default

1000

Inherited from

UploadCoreOptions.retryDelay


signal?

optional signal: AbortSignal

Defined in: src/browser/core.ts:88

An AbortSignal for external cancellation (e.g. from an AbortController, React Query, or TanStack Query). When the signal fires, the in-flight XHR is aborted immediately. Works alongside the hook’s built-in abort() method.

Inherited from

UploadCoreOptions.signal


timeout?

optional timeout: number

Defined in: src/browser/core.ts:60

Upload timeout in milliseconds. Set to 0 to disable.

Default

0

Inherited from

UploadCoreOptions.timeout