---
name: "getStorageInfo"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "3.30.1" }
  - { name: "@ray-js/ray", version: "1.7.60" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getStorageInfo - 异步获取当前 storage 的相关信息"
---

## getStorageInfo

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

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

异步获取当前storage的相关信息

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `keys` | `string[]` | `3.30.1` | 当前 storage 中所有的 key |
| `currentSize` | `number` | `3.30.1` | 当前占用的空间大小, 单位kb |
| `limitSize` | `number` | `3.30.1` | 限制的空间大小，单位kb |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### Demo

```tsx
import { getStorageInfo } from '@ray-js/ray'

// 获取当前 storage 信息：所有 key、已用大小、限制大小（kb）
getStorageInfo({
  success: data => console.log("keys:", data.keys, "已用:", data.currentSize, "限制:", data.limitSize),
  fail: error => console.error(error),
});
```