---
name: "batchGetStorage"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "3.30.1" }
  - { name: "@ray-js/ray", version: "1.7.60" }
platform:
  - "iOS"
  - "Android"
async: true
---

## batchGetStorage

> [VERSION] BaseKit >= 3.30.1 | @ray-js/ray >= 1.7.60

> [PLATFORM] iOS, Android

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

### Description

Asynchronously batch-get the values for the specified keys from local storage

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `keyList` | `string[]` | Yes | - | `3.30.1` | List of keys to fetch |
| `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 |
| --- | --- | --- | --- |
| `dataList` | `string[]` | `3.30.1` | List of retrieved key-value pairs |

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

// Batch retrieve local storage: first write in batch, then read in batch to demonstrate a full round trip
batchSetStorage({
  kvList: [
    { key: "k1", data: "v1" },
    { key: "k2", data: "v2" },
  ],
  success: () => {
    batchGetStorage({
      keyList: ["k1", "k2"],
      success: data => console.log("Batch read:", data.dataList),
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});
```