FileUploadHookResult
Parameters
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.
isError required
boolean
@returns
true
if an error occurred
@depreacted
use !isSuccess
or !!error
instead
error required
null | StorageErrorPayload
Provides details about the error
add required
(params: StorageUploadFileParams) => void
upload required
(params: Partial<StorageUploadFileParams>) => Promise<UploadFileHandlerResult>
cancel required
() => void