---
name: "DownloadTask.abort"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
platform:
  - "iOS"
  - "Android"
title: "DownloadTask.abort - 中断下载任务"
---

## DownloadTask.abort

> [VERSION] BaseKit >= 2.0.1

> [PLATFORM] iOS, Android

### 描述

中断下载任务

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### Demo

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

// abort 是 DownloadTask 上的方法，需先用 ty.downloadFile 拿到下载任务句柄。
const downloadTask = await downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_video.mp4",
});

downloadTask.abort({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```