Interface ReactUploadLifecycleOptions<Upload>

Lifecycle callbacks accepted by React upload hooks.

interface ReactUploadLifecycleOptions<Upload extends UploadDef> {
    onError?(error: unknown): void | Promise<void>;
    onFileBegin?(event: UploadClientFileEvent): void;
    onProgress?(event: UploadClientProgressEvent): void;
    onSettled?(
        result: CompleteUploadResult<InferUploadResult<Upload>> | undefined,
        error: unknown,
    ): void | Promise<void>;
    onSuccess?(
        result: CompleteUploadResult<InferUploadResult<Upload>>,
    ): void | Promise<void>;
}

Type Parameters

Upload extends UploadDef

Index

Methods

onError? onFileBegin? onProgress? onSettled? onSuccess?

Methods

`Optional`onError

onError?(error: unknown): void | Promise<void>
Called after the upload client throws.
Parameters
- error: unknown
Returns void | Promise<void>
- Defined in index.ts:115

`Optional`onFileBegin

onFileBegin?(event: UploadClientFileEvent): void
Called when a file is about to be uploaded.
Parameters
- event: UploadClientFileEvent
Returns void
- Defined in index.ts:101

`Optional`onProgress

onProgress?(event: UploadClientProgressEvent): void
Called when the upload client reports file progress.
Parameters
- event: UploadClientProgressEvent
Returns void
- Defined in index.ts:105

`Optional`onSettled

onSettled?(
result: CompleteUploadResult<InferUploadResult<Upload>> | undefined,
error: unknown,
): void | Promise<void>
Called after either success or failure.
Parameters
- result: CompleteUploadResult<InferUploadResult<Upload>> | undefined
- error: unknown
Returns void | Promise<void>
- Defined in index.ts:119

`Optional`onSuccess

onSuccess?(
result: CompleteUploadResult<InferUploadResult<Upload>>,
): void | Promise<void>
Called after the upload completes successfully.
Parameters
- result: CompleteUploadResult<InferUploadResult<Upload>>
Returns void | Promise<void>
- Defined in index.ts:109