Interface ReactUploadState<Upload>

State returned by Beignet React upload hooks.

interface ReactUploadState<Upload extends UploadDef> {
    error: unknown;
    files: readonly ReactUploadFileState[];
    progress: number;
    progressFraction: number;
    result: CompleteUploadResult<InferUploadResult<Upload>> | null;
    status: ReactUploadStatus;
}

Type Parameters

Upload extends UploadDef

Hierarchy (View Summary)

ReactUploadState
- ReactUploadController

Index

Properties

error files progress progressFraction result status

Properties

error

error: unknown

Latest error thrown by the upload client.

files

files: readonly ReactUploadFileState[]

Per-file progress state for the active or latest upload.

progress

progress: number

Aggregate upload progress from 0 to 100.

progressFraction

progressFraction: number

Aggregate upload progress from 0 to 1.

result

result: CompleteUploadResult<InferUploadResult<Upload>> | null

Latest successful upload result.

status

status: ReactUploadStatus

Current upload lifecycle status.