# @flags-sdk/global-config 中文文档

规范地址：https://npmcn.com/package/%40flags-sdk/global-config/

版本：0\.3\.1
npm 元数据更新时间：2026-08-12T06:40:35.655Z
中文译文更新时间：2026-11-14T21:11:03.574Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flags-sdk/global-config
原文对照：https://npmcn.com/package/%40flags-sdk/global-config/?lang=original
项目主页：https://github.com/vercel/flags#readme
源码仓库：https://github.com/vercel/flags

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

- 包体积（解压后）：23.3 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-08-04T15:29:52.611Z
- 最新版本发布：2026-08-12T06:40:35.302Z
- 近 30 天下载量：8358（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

全球配置的旗舰 SDK 适配器

## 安装

```sh
npm install @flags-sdk/global-config
```

也可以使用：`pnpm add @flags-sdk/global-config`、`yarn add @flags-sdk/global-config`、`bun add @flags-sdk/global-config`

## README

# `@flags-sdk/global-config`

## 安装

```bash
npm install @flags-sdk/global-config
```

## 使用量

## 使用默认适配器

此适配器将连接到在 `GLOBAL_CONFIG` 环境变量,并读取 Global 配置中一个密钥中名为 `flags`。 。 。 .

```ts
import { flag } from "flags/next";
import { globalConfigAdapter } from "@flags-sdk/global-config";

export const exampleFlag = flag({
  key: "example-flag",
  adapter: globalConfigAdapter,
});
```

您的全球配置应该像这样:

```json
{
  "flags": {
    "example-flag": true
  }
}
```

## 使用自定义适配器

您可以指定一个自定义适配器, 连接到不同的全局配置, 并读取

```ts
import { flag } from "flags/next";
import { createGlobalConfigAdapter } from "@flags-sdk/global-config";

const globalConfigAdapter = createGlobalConfigAdapter(process.env.GLOBAL_CONFIG, {
  teamSlug: "your-team-slug",
  globalConfigItemKey: "my-flags",
});

export const exampleFlag = flag({
  key: "example-flag",
  adapter: globalConfigAdapter,
});
```

您的全球配置应该像这样:

```json
{
  "my-flags": {
    "example-flag": true
  }
}
```

提供习惯 `teamSlug` 允许适配器生成一个 `origin` 用于您的旗帜, 从而允许旗下探索者链接到您的全球配置 。 这是可选的,不影响运行时的行为.

## 常见问题

### @flags-sdk/global-config 是什么？

全球配置的旗舰 SDK 适配器

### 如何安装 @flags-sdk/global-config？

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

### @flags-sdk/global-config 支持 TypeScript 吗？

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

### @flags-sdk/global-config 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @flags-sdk/global-config 可以商用吗？

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

### @flags-sdk/global-config 的下载量有多少？

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

### @flags-sdk/global-config 还在维护吗？

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

