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

## getStorageInfo

> [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 obtain information about the current storage

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `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 |
| --- | --- | --- | --- |
| `keys` | `string[]` | `3.30.1` | All keys in the current storage |
| `currentSize` | `number` | `3.30.1` | Current space used, in KB |
| `limitSize` | `number` | `3.30.1` | Space limit, in KB |

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

// Get current storage info: all keys, used size, limit size (KB)
getStorageInfo({
  success: data => console.log("keys:", data.keys, "used:", data.currentSize, "limit:", data.limitSize),
  fail: error => console.error(error),
});
```