# @configdirector/nuxt-sdk 中文文档

规范地址：https://npmcn.com/package/%40configdirector/nuxt-sdk/

版本：1\.14\.2
npm 元数据更新时间：2026-11-07T23:17:07.568Z
中文译文更新时间：2026-11-10T16:08:21.943Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40configdirector/nuxt-sdk
原文对照：https://npmcn.com/package/%40configdirector/nuxt-sdk/?lang=original
项目主页：https://www.configdirector.com/
源码仓库：https://github.com/ConfigDirector/js-sdks

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

- 包体积（解压后）：593 kB，47 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2026-04-29T17:32:33.248Z
- 最新版本发布：2026-11-07T23:17:07.253Z
- 近 30 天下载量：3123（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：36（近 12 个月 36 个）

## 中文简介

Nuxt SDK为"配置总监". Cifig Director是一个远程配置和功能旗服务.

## 安装

```sh
npm install @configdirector/nuxt-sdk
```

也可以使用：`pnpm add @configdirector/nuxt-sdk`、`yarn add @configdirector/nuxt-sdk`、`bun add @configdirector/nuxt-sdk`

## README

# 配置主任 Nuxt SDK

[![npm](https://img.shields.io/npm/v/@configdirector/nuxt-sdk.svg)](https://www.npmjs.com/package/@configdirector/nuxt-sdk)

Nuxt SDK 为 [配置主任](https://www.configdirector.com/),远程配置和带有打出值的特征旗帜,JSON Schema验证,以及安全地重命名活旗帜. 免费开始,不需要卡片.

## 安装

```bash
npm install --save @configdirector/nuxt-sdk
```

## 获取一个值

```ts
// nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@configdirector/nuxt-sdk"],
  runtimeConfig: {
    public: { configdirector: { clientSdkKey: "YOUR-CLIENT-SDK-KEY" } },
    configdirector: { serverSdkKey: "YOUR-SERVER-SDK-KEY" },
  },
});
```

```vue
<script setup lang="ts">
const { value: darkMode } = useConfigDirectorValue("dark-mode", false);
</script>
```

详细情况见 [正式文件](https://docs.configdirector.com/sdks/meta/nuxt)。 。 。 .

## 测试您的代码

`@configdirector/nuxt-sdk/testing` 创建一个连接到内存服务器的真正的客户端 测试控制。 在 Nuxt app 创建之前在测试文件或测试文件的顶端安装 vitest 设置文件, 配置管理器插件提供给应用程序而不是构建一个 客户端。 测试在 `nuxt` 环境状况 `@nuxt/test-utils` 4(需要vitest 4) (中文(简体) ).

```ts
import { nextTick } from "vue";
import { mountSuspended } from "@nuxt/test-utils/runtime";
import { createTestClient, installTestClient } from "@configdirector/nuxt-sdk/testing";
import Checkout from "~/components/Checkout.vue";

const testClient = createTestClient({ values: { "dark-mode": true } });
installTestClient(testClient);

test("renders the dark mode", async () => {
  const component = await mountSuspended(Checkout);
  expect(component.text()).toContain("dark-mode: true");

  testClient.setValue("dark-mode", false);
  await nextTick();
  expect(component.text()).toContain("dark-mode: false");
});
```

`@nuxt/test-utils` 4 在每个测试文件内创建应用程序 `beforeAll` 钩子,所以安装在 模块级别而不是钩子,然后在测试之间重置值 `replaceValues`。 。 。 . `@nuxt/test-utils` 3 在测试文件负载前创建应用程序, 因此插件无法看到测试 安装在那里的客户端; 升级以使用测试条目. 虽然 已安装, 插件不需要 `clientSdkKey`等待时 `nextTick()` 之后 `setValue`, (中文(简体) ), `removeValue`, (中文(简体) ), 财务报告和审定财务报表 `replaceValues`。测试客户端也持有或失败 `initialize` 财务报告和审定财务报表 `updateContext`,以及 记录每个上下文 `contextUpdates`。 。 。 .

## 文档

参见 [nuxt SDK 的正式文件](https://docs.configdirector.com/sdks/meta/nuxt)。 。 。 .

还有 [一个快速启动指南 配置主任和我们的任何SDK](https://docs.configdirector.com/getting-started/quickstart)。 。 。 .

## 获取帮助

-   [在讨论中提问](https://github.com/orgs/ConfigDirector/discussions)
-   [联系支助](https://www.configdirector.com/support)

## 常见问题

### @configdirector/nuxt-sdk 是什么？

Nuxt SDK为"配置总监"\. Cifig Director是一个远程配置和功能旗服务\.

### 如何安装 @configdirector/nuxt-sdk？

在项目目录运行 npm install @configdirector/nuxt-sdk，或使用 pnpm add / yarn add / bun add。

### @configdirector/nuxt-sdk 支持 TypeScript 吗？

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

### @configdirector/nuxt-sdk 支持 ESM 还是 CommonJS？

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

### @configdirector/nuxt-sdk 可以商用吗？

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

### @configdirector/nuxt-sdk 的下载量有多少？

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

### @configdirector/nuxt-sdk 还在维护吗？

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