Class UploadAPI

constructor

• new UploadAPI(
      config: UploadConfig,
      onChange: ChangeCallback,
      onError: ErrorCallback,
  ): UploadAPI

  Parameters

  • config: UploadConfig
  • onChange: ChangeCallback
  • onError: ErrorCallback

  Returns UploadAPI

Readonlyfile

Readonlyid

cancel

• cancel(): Promise<void>

  Cancels the upload by making a cancellation request to the backend. Triggers the onChange callback.

  Returns Promise<void>

getProgress

• getProgress(): Progress

  Returns the current upload progress metrics.

  Returns Progress

  The current upload progress metrics.

getStatus

• getStatus(): Status

  Returns the current upload status.

  Returns Status

  The current upload status

start

• start(): void

  Starts the file upload. Triggers the onChange callback.

  Returns void

Staticinitialize

• initialize(config: ApiConfig): Promise<UploadAPI | null>

  Parameters

  • config: ApiConfig

  Returns Promise<UploadAPI | null>