# @alevy97/react-native-userdefaults 中文文档

规范地址：https://npmcn.com/package/%40alevy97/react-native-userdefaults/

版本：0\.2\.2
npm 元数据更新时间：2024-08-14T01:42:23.609Z
中文译文更新时间：2026-11-06T04:22:59.076Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40alevy97/react-native-userdefaults
原文对照：https://npmcn.com/package/%40alevy97/react-native-userdefaults/?lang=original
项目主页：https://github.com/andrew-levy/react-native-userdefaults
源码仓库：https://github.com/andrew-levy/react-native-userdefaults

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：17.9 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：expo \*，react \*，react-native \*
- 首次发布：2022-04-12T03:12:42.848Z
- 最新版本发布：2024-08-14T01:42:23.418Z
- 近 30 天下载量：5193（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 0 个）

## 中文简介

本地反应中的用户默认值

## 安装

```sh
npm install @alevy97/react-native-userdefaults
```

也可以使用：`pnpm add @alevy97/react-native-userdefaults`、`yarn add @alevy97/react-native-userdefaults`、`bun add @alevy97/react-native-userdefaults`

## README

# 用户过失

一个用户默认数据库的接口,您在应用程序的启动过程中持续存储密钥值对。 灵感来自 [用户过失](https://developer.apple.com/documentation/foundation/userdefaults)。 。 。 .

-   : white check mark: 已建 [Expo 模块 API](https://docs.expo.dev/modules/module-api/)
-   : white check mark: 以类型脚本和斯威夫特写成
-   :apple:目前只使用iOS

## 安装

1.  安装软件包

```console
yarn add @alevy97/react-native-userdefaults
```

2.  安装吊舱

```console
npx pod-install
```

## 使用量

### 标准默认

最常见的使用例 `UserDefaults` 将小块数据存储到标准默认系统。 您可以使用静态属性访问标准默认系统 `UserDefaults.standard` 或创建新的 `UserDefaults` 举个例子.

```tsx
UserDefaults.standard;
```

或相当

```tsx
new UserDefaults();
```

### 带有套接字名称的默认

UserDefaults也可以用来存储可以共享于属于同一软件的多个应用程序的数据 [App 组](https://developer.apple.com/documentation/xcode/configuring-app-groups?changes=_3),也被称为套房。 为此,在创建一个 `UserDefaults` 举个例子.

```tsx
new UserDefaults("group.com.example.app");
```

### 示例

```tsx
import { Button, View } from "react-native";
import UserDefaults from "@alevy97/react-native-userdefaults";

const standardDefaults = UserDefaults.standard; // or new UserDefaults()
const groupDefaults = new UserDefaults("group.com.example.app");

function App() {
  return (
    <View>
      <Button
        title="Set Values"
        onPress={async () => {
          await standardDefaults.set("darkMode", true);
          await groupDefaults.set("coolNumbers", [3.14, 2.71, 1.41]);
        }}
      />
      <Button
        title="Get Values"
        onPress={async () => {
          const darkMode = await standardDefaults.get("darkMode");
          const coolNumbers = await groupDefaults.get("coolNumbers");
          console.log(darkMode, coolNumbers);
        }}
      />
    </View>
  );
}
```

## API 密码

```typescript
interface UserDefaults {
  /* Standard user defaults object */
  standard: UserDefaults;
  /* Get the value for a given key */
  get(forKey: string): Promise<any>;
  /* Set a value for a given key */
  set(forKey: string, value: any): Promise<void>;
  /* Remove a value for a given key */
  remove(forKey: string): Promise<void>;
  /* Removes all user default values */
  removeAll(): Promise<void>;
  /* Returns all user default values */
  getAll(): Promise<{ [key: string]: any }>;
}
```

## 常见问题

### @alevy97/react-native-userdefaults 是什么？

本地反应中的用户默认值

### 如何安装 @alevy97/react-native-userdefaults？

在项目目录运行 npm install @alevy97/react-native-userdefaults，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：expo（\*）、react（\*）、react-native（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @alevy97/react-native-userdefaults 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @alevy97/react-native-userdefaults 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @alevy97/react-native-userdefaults 可以商用吗？

@alevy97/react-native-userdefaults 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @alevy97/react-native-userdefaults 的下载量有多少？

根据 npm 官方下载统计，@alevy97/react-native-userdefaults 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,193 次，日均约 173 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @alevy97/react-native-userdefaults 还在维护吗？

最新版本 0\.2\.2 发布于 2024/08/14（2 年前）；至今共发布 5 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/04/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。