Interface FileUploadActions

remarks: @since 2.9.0

Hierarchy

FileUploadActions
- FileUploadHookReturnValue

Index

Methods

Methods

clearErrors

clearErrors(): void

- Defined in packages/form/src/file-input/useFileUpload.ts:125
Removes all the errors that exist in state without cancelling any of the uploads already in progress.

Returns void

remove

remove(keyOrKeys: string | readonly string[]): void

- Defined in packages/form/src/file-input/useFileUpload.ts:134
This function is used to cancel pending and uploading files or removing completed files.

Parameters
- keyOrKeys: string | readonly string[]
  
  A single or list of BaseFileUploadStats.key to remove from state.
Returns void

reset

reset(): void

- Defined in packages/form/src/file-input/useFileUpload.ts:119
Reset everything related to uploads ensuring that all file readers have been aborted.

Returns void

Generated using TypeDoc