---
name: "resizeImage"
mode: "kit"
versionRequirements:
  - { name: "BizKit", version: "3.0.0" }
platform:
  - "iOS"
  - "Android"
async: true
title: "resizeImage"
---

## resizeImage

> [VERSION] BizKit >= 3.0.0

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Compress an image. Crop to the target size while preserving the original aspect ratio, then apply quality compression based on the file-size limit.

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `aspectFitWidth` | `number` | Yes | - | `3.0.0` | Compression parameters aspectFitWidth Auto-fit width |
| `aspectFitHeight` | `number` | Yes | - | `3.0.0` | aspectFitHeight Auto-fit height |
| `maxFileSize` | `number` | No | - | `3.0.0` | maxFileSize Maximum image file size limit; if empty, no limit. Unit: B |
| `path` | `string` | Yes | - | `3.0.0` | path Image path |
| `complete` | `() => void` | No | - | - | Complete callback (called on success or failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Success callback |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `path` | `string` | `3.1.2` | Returned image data path Image path |

#### 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` | Extended error code |
| `errorMsg` | `string` | Extended error message |


### Examples

```tsx
// Download a real image to a local path first, then resize it.
ty.downloadFile({
  url:
    "https://images.tuyacn.com/rms-static/b7bed040-87b8-11eb-864d-a9f07cbbdf37-1616051299140.png?tyName=logo_cn.png",
  success: res => {
    const path = res.tempFilePath || res.filePath || res.apFilePath;
    console.log("downloaded", path);
    ty.resizeImage({
      aspectFitWidth: 200,
      aspectFitHeight: 200,
      maxFileSize: 102400,
      path: path,
      success: data => {
        console.log(data);
      },
      fail: error => {
        console.error(error);
      },
    });
  },
  fail: error => {
    console.error(error);
  },
});
```