API ReferenceinterfacesUsemultipleuploadreturn

upload-with-progress


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

Type Parameters

TMeta

TMeta

Properties

abort()

abort: (id) => void

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

Cancel a single upload by job ID.

Parameters

id

string

Returns

void


abortAll()

abortAll: () => void

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

Cancel all in-flight uploads.

Returns

void


isUploadingAll

isUploadingAll: boolean

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

Whether any upload is currently in flight.


jobs

jobs: UploadJob<TMeta>[]

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

Per-file job states.


overallProgress

overallProgress: number

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

Weighted overall progress (0 – 100).


reset()

reset: () => void

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

Reset the hook to its initial idle state, aborting all uploads.

Returns

void


upload()

upload: (files, getUploadUrl) => Promise<MultipleUploadResult<TMeta>[]>

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

Initiate a batch upload.

Parameters

files

File[]

getUploadUrl

(file, index) => Promise<GetUploadUrlResponse<TMeta>>

Returns

Promise<MultipleUploadResult<TMeta>[]>