---
name: "fetchImageThumbnail"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "3.14.2" }
  - { name: "@ray-js/ray", version: "1.5.30" }
platform:
  - "iOS"
  - "Android"
async: true
title: "fetchImageThumbnail - Get an image thumbnail"
---

## fetchImageThumbnail

> [VERSION] BaseKit >= 3.14.2 | @ray-js/ray >= 1.5.30

> [PLATFORM] iOS, Android

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

### Description

Get image thumbnail

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `originPath` | `string` | Yes | - | `3.14.2` | Original resource URL |
| `thumbWidth` | `number` | Yes | - | `3.14.2` | Thumbnail width (px) |
| `thumbHeight` | `number` | Yes | - | `3.14.2` | Thumbnail height (px) |
| `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 |
| --- | --- | --- | --- |
| `thumbnailPath` | `string` | `3.14.2` | Thumbnail URL |

#### 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, fetchImageThumbnail } from '@ray-js/ray'

// Get image thumbnail: download the image first, then generate a thumbnail with the specified width and height
downloadFile({
  url: "https://airtake-public-data-1254153901.cos.ap-shanghai.myqcloud.com/ttttestfile/test_image.jpg",
  success: ({ tempFilePath }) => {
    fetchImageThumbnail({
      originPath: tempFilePath,
      thumbWidth: 100,
      thumbHeight: 100,
      success: data => console.log("Thumbnail path:", data.thumbnailPath),
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});
```