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

## RequestTask.abort

> [VERSION] BaseKit >= 2.0.1

> [PLATFORM] iOS, Android

### Description

Abort request 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 { request } from '@ray-js/ray'

// Abort a request task. ty.request returns a RequestTask; call task.abort to abort the request, and abort returns the result via the success callback.
// Note: abort is called after the request result returns to demonstrate how to call abort and a successful callback.
let task;
task = request({
  url: "https://httpbin.org/get",
  method: "GET",
  success: data => {
    console.log(data);
    task.abort({
      success: () => {
        console.log("abort success");
      },
      fail: error => {
        console.error(error);
      },
    });
  },
  fail: error => {
    console.error(error);
  },
});
```