Defined in: src/browser/useUpload.ts:34
Type Parameters
TMeta
TMeta
Properties
abort()
abort: () =>
void
Defined in: src/browser/useUpload.ts:38
Cancel the in-flight upload.
Returns
void
error
error:
null|UploadError
Defined in: src/browser/useUpload.ts:48
The last UploadError, or null.
isUploading
isUploading:
boolean
Defined in: src/browser/useUpload.ts:44
Whether an upload is currently in flight.
progress
progress:
number
Defined in: src/browser/useUpload.ts:42
Upload progress percentage (0 – 100).
reset()
reset: () =>
void
Defined in: src/browser/useUpload.ts:40
Reset the hook to its initial idle state.
Returns
void
status
status:
UploadStatus
Defined in: src/browser/useUpload.ts:46
Lifecycle status: idle → uploading → success | error.
upload()
upload: (
file,getUploadUrl) =>Promise<TMeta>
Defined in: src/browser/useUpload.ts:36
Initiate a file upload.
Parameters
file
File
getUploadUrl
GetUploadUrl<TMeta>
Returns
Promise<TMeta>