Skip to main content



isError required boolean


true if an error occurred


use !isSuccess or !!error instead

error required null | ErrorPayload

Provides details about the error

isUploading required boolean

Returns true when the file is being uploaded.

progress required null | number

Returns the progress of the upload, from 0 to 100. Returns null if the upload has not started yet.

isUploaded required boolean

Returns true when the file has been successfully uploaded.

id optional string

Returns the id of the file.

bucketId optional string

Returns the bucket id.

name optional string

Returns the name of the file.

add required (params: StorageUploadParams) => void

upload required (params: Partial<StorageUploadParams>) => Promise<UploadFileHandlerResult>

cancel required () => void