# @flaggly/sdk 中文文档

规范地址：https://npmcn.com/package/%40flaggly/sdk/

版本：0\.2\.0
npm 元数据更新时间：2026-02-21T11:30:51.836Z
中文译文更新时间：2026-11-14T21:10:50.745Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：34.1 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-10-06T07:05:52.060Z
- 最新版本发布：2026-02-21T11:30:51.488Z
- 近 30 天下载量：4088（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 1 个）

## 中文简介

旗下客户端 SDK

## 安装

```sh
npm install @flaggly/sdk
```

也可以使用：`pnpm add @flaggly/sdk`、`yarn add @flaggly/sdk`、`bun add @flaggly/sdk`

## README

# @ flaggly/ sdk (英语)

客户端 SDK 为 [旗帜](https://flaggly.dev/) - 在Cloudflare Workers上自办的地标旗服务.

## 安装

```sh
pnpm i @flaggly/sdk
```

## 设置

定义您的旗帜图案并创建客户端 :

```ts
import { Flaggly } from '@flaggly/sdk';

type Flags = {
  'dark-mode': { type: 'boolean' };
  'banner': { type: 'payload'; result: { text: string; color: string } };
  'checkout': { type: 'variant'; result: string };
};

const flaggly = new Flaggly<Flags>({
  url: 'https://flaggly.example.workers.dev',
  apiKey: 'YOUR_USER_JWT',
});
```

国旗在创建时立即进行评估. 过 `lazy: true` 等待直到你打电话 `identify()` 或者说 `fetchFlags()`。 。 。 .

## 使用量

```ts
// Type-safe getters
const isDarkMode = flaggly.getBooleanFlag('dark-mode');
const banner = flaggly.getPayloadFlag('banner');
const checkout = flaggly.getVariantFlag('checkout');
```

### 识别用户

打电话 `identify()` 当用户登录时。 重新评价所有旗子的用户背景 :

```ts
await flaggly.identify(userId, { email: user.email, tier: user.tier });
```

### 反应

```ts
import { Flaggly, FlagValue } from '@flaggly/sdk';
import { useSyncExternalStore } from 'react';

const flaggly = new Flaggly<Flags>({
  url: 'https://flaggly.example.workers.dev',
  apiKey: 'YOUR_USER_JWT',
  lazy: true,
  bootstrap: {
    'dark-mode': false,
  },
});

export const useFlags = () =>
  useSyncExternalStore(flaggly.store.subscribe, flaggly.store.get, flaggly.store.get);

export const useFlag = <K extends keyof Flags>(key: K): FlagValue<Flags[K]> => {
  const data = useFlags();
  return data?.[key].result as FlagValue<Flags[K]>;
};
```

### Cloudflare工人(服务约束)

```ts
const flaggly = new Flaggly<Flags>({
  url: 'https://flaggly.example.workers.dev',
  apiKey: 'YOUR_USER_JWT',
  lazy: true,
  workerFetch: (url, init) => env.FLAGGLY_SERVICE.fetch(url, init),
});
```

## 选项

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `url` | `string` | \- 说吧 | 您旗下工人的基础 URL |
| `apiKey` | `string` | \- 说吧 | 公共用户 JWT |
| `app` | `string` | `"default"` | 应用标识符 |
| `env` | `string` | `"production"` | 环境标识符 |
| `lazy` | `boolean` | `false` | 在手动调用前推迟国旗评价 |
| `bootstrap` | `Partial<FlagValues>` | \- 说吧 | 第一次获取前的默认值 |
| `workerFetch` | `typeof fetch` | `fetch` | 自定义获取服务绑定 |
| `getBackupId` | `() => string` | \- 说吧 | 自定义匿名用户ID生成器 |
| `customStorage` | `CustomStorage` | `localStorage` | 备份ID存储 |
| `getCurrentRoute` | `() => string | null` | `window.location.href` | 非浏览器嵌入器的路由提供者 |
| `getRandomId` | `() => string` | `crypto.randomUUID` | 非浏览器管道的 UUID 生成器 |

## 文档

页:1 [(原始内容存档于2017-06-21). glagly.dev](https://flaggly.dev/)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @flaggly/sdk 是什么？

旗下客户端 SDK

### 如何安装 @flaggly/sdk？

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

### @flaggly/sdk 支持 TypeScript 吗？

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

### @flaggly/sdk 支持 ESM 还是 CommonJS？

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

### @flaggly/sdk 可以商用吗？

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

### @flaggly/sdk 的下载量有多少？

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

### @flaggly/sdk 还在维护吗？

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