---
name: "UploadTask.abort"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
platform:
  - "iOS"
  - "Android"
---

## UploadTask.abort

> [VERSION] BaseKit >= 2.0.1

> [PLATFORM] iOS, Android

### Description

Abort upload task

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | No | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

```tsx
import { downloadFile, uploadFile } from '@ray-js/ray'

// Abort an upload task: call task.abort() after obtaining the UploadTask
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_image.jpg",
  success: ({ tempFilePath }) => {
    const task = uploadFile({
      url: "https://httpbin.org/post",
      filePath: tempFilePath,
      name: "file",
      success: () => {
        task.abort({
          success: () => console.log("Upload task aborted"),
          fail: error => console.error(error),
        });
      },
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});
```