# @frigear-nu/preferences 中文文档

规范地址：https://npmcn.com/package/%40frigear-nu/preferences/

版本：0\.3\.0
npm 元数据更新时间：2026-11-12T15:51:12.890Z
中文译文更新时间：2026-11-15T16:26:31.608Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40frigear-nu/preferences
原文对照：https://npmcn.com/package/%40frigear-nu/preferences/?lang=original
项目主页：https://docs.frigear.dev/modules/identity/preferences
源码仓库：https://github.com/Frigear-nu/frigear-nu

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

- 包体积（解压后）：21.6 kB，28 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：8 个
- peer 依赖：@nuxthub/core ^0\.10\.12，@frigear-nu/oauth-server \>=0\.0\.1
- 首次发布：2026-10-14T11:27:58.072Z
- 最新版本发布：2026-11-12T15:51:12.143Z
- 近 30 天下载量：2380（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

输入了每个用户的首选项,这些模块和主机应用程序注册,存储在用户上,并可选择地传输到OAuth应用程序作为债权.

## 安装

```sh
npm install @frigear-nu/preferences
```

也可以使用：`pnpm add @frigear-nu/preferences`、`yarn add @frigear-nu/preferences`、`bun add @frigear-nu/preferences`

## README

# @frigear-nu/首选项

输入模块和主机应用程序注册的每个用户首选项 `definePreferences`,存储在 JSON 一列 打开 `users`,并可选择作为债权转交OAuth申请.

```ts
// shared/preferences.ts
import { z } from 'zod'
import { definePreferences } from '@frigear-nu/preferences/define'

export default definePreferences({
  compactTables: z.boolean(),
  colorMode: { schema: z.enum(['light', 'dark', 'system']), claim: 'color_mode' },
})
```

`useUserPreferences()` 客户端和 `getUserPreference(user, key)` 服务器上输入的都是这些图案. 见 [文档](https://docs.frigear.dev/modules/identity/preferences)。 。 。 .

## 常见问题

### @frigear-nu/preferences 是什么？

输入了每个用户的首选项,这些模块和主机应用程序注册,存储在用户上,并可选择地传输到OAuth应用程序作为债权\.

### 如何安装 @frigear-nu/preferences？

在项目目录运行 npm install @frigear-nu/preferences，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@nuxthub/core（^0\.10\.12）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @frigear-nu/preferences 支持 TypeScript 吗？

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

### @frigear-nu/preferences 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @frigear-nu/preferences 可以商用吗？

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

### @frigear-nu/preferences 的下载量有多少？

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

### @frigear-nu/preferences 还在维护吗？

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