---
name: "setStorageSync"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.0.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
title: "setStorageSync - 将数据存储在本地缓存中指定的 key 中"
---

## setStorageSync

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

> [PLATFORM] iOS, Android

### 描述

将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `key` | `string` | 是 | - | `2.0.1` | 本地缓存中指定的 key |
| `data` | `string` | 是 | - | `2.0.1` | key对应的内容 |

### 示例代码

#### Demo

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

// 将数据写入本地缓存指定 key（覆盖原内容）
setStorage({
  key: "demoKey",
  data: "demoValue",
  success: () => console.log("已写入"),
  fail: error => console.error(error),
});
```