---
name: "getStorageSync"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
---

## getStorageSync

> [VERSION] BaseKit >= 2.0.1 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

### Description

Asynchronously get the value for the specified key from local storage

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `key` | `string` | Yes | - | `2.0.1` | The specified key in local storage |

### Examples

#### Demo

```tsx
import { setStorage, getStorage } from '@ray-js/ray'

// Get the value of the specified key in local storage: write then read to demonstrate a full round trip
setStorage({
  key: "demoKey",
  data: "demoValue",
  success: () => {
    getStorage({
      key: "demoKey",
      success: data => console.log("Read value:", data),
      fail: error => console.error(error),
    });
  },
  fail: error => console.error(error),
});
```