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

## resizeImage

> [VERSION] BizKit >= 3.0.0 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

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

### Description

Compress an image: first 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 Adaptive width |
| `aspectFitHeight` | `number` | Yes | - | `3.0.0` | aspectFitHeight Adaptive 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 | - | - | Completion callback (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `path` | `string` | `3.1.2` | Image return content 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` | Error extension code |
| `errorMsg` | `string` | Error extension message |