# @frigade/js 中文文档

规范地址：https://npmcn.com/package/%40frigade/js/

版本：0\.9\.12
npm 元数据更新时间：2026-11-03T22:37:22.104Z
中文译文更新时间：2026-11-15T14:17:35.597Z
软件包许可：ELv2

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

原始 npm 页面：https://www.npmjs.com/package/%40frigade/js
原文对照：https://npmcn.com/package/%40frigade/js/?lang=original
项目主页：https://github.com/FrigadeHQ/javascript/tree/main/packages/js-api#readme
源码仓库：https://github.com/FrigadeHQ/javascript

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

- 包体积（解压后）：309 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2023-07-17T07:23:04.683Z
- 最新版本发布：2026-09-16T18:57:32.666Z
- 近 30 天下载量：117635（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：135（近 12 个月 7 个）

## 中文简介

官方Javascript SDK for Frigade. (原始内容存档于2018-10-12).

## 安装

```sh
npm install @frigade/js
```

也可以使用：`pnpm add @frigade/js`、`yarn add @frigade/js`、`bun add @frigade/js`

## README

[![npm version](https://img.shields.io/npm/v/@frigade/js)](https://www.npmjs.com/package/@frigade/js) [![npm version](https://github.com/FrigadeHQ/javascript/actions/workflows/tests.yml/badge.svg)](https://github.com/FrigadeHQ/javascript/actions/workflows/tests.yml) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

### **Frigade Javascript SDK (英语)**

开发商最容易搭建高品质产品上载和教育.

  

[网站](https://frigade.com/) • 妇女 [演示](https://demo.frigade.com/) • 妇女 [GitHub 图像](https://github.com/FrigadeHQ) • 妇女 [文档](https://docs.frigade.com/v2/sdk/js/quickstart)

  

![Frigade image](https://cdn.frigade.com/0534ad31-8dc3-4061-9e53-53aae2ff3cf8.png)

## 安装

从命令行安装软件包 .

#### 用纱线

```bash
yarn add @frigade/js
```

#### 与 npm 关系

```bash
npm install @frigade/js
```

## 使用量

简单 `import { Frigade } from '@frigade/js'` 并使用它。 示例

```js
import { Frigade } from 'packages/js-api'

const frigade = new Frigade('FRIGADE_API_KEY')

await frigade.identify('USER_ID', {
  name: 'USER_NAME',
  email: 'USER_EMAIL',
  signed_up_at: 'USER_SIGNED_UP_AT' // ISO 8601 format
})

// Optional: send organization/group id
await frigade.group('ORGANIZATION_ID', {
  name: 'COMPANY_NAME',
})
```

## API 参考

见 [完整 API 引用](https://docs.frigade.com/v2/sdk/js/quickstart)

#### 获取流量 :

```js
const flow = await frigade.getFlow('FLOW_ID')
// Flow data defined in config.yml in the Frigade dashboard
console.log('Flow status:', flow.isCompleted)
console.log('Flow data:', flow.rawData)
```

#### 将流量标为已完成 :

```js
const flow = await frigade.getFlow('FLOW_ID')
await flow.complete()
```

#### 将流量中的一步标为已完成 :

```js
const flow = await frigade.getFlow('FLOW_ID')
const step = flow.steps.get('STEP_ID')
await step.start()
await step.complete()
```

#### 发送跟踪事件 :

```js
await frigade.track('EVENT_NAME', {
  property1: 'value1',
  property2: 'value2',
})
```

#### 事件处理器

全球事件处理器可以在任何流量发生状态变化时被注册以通知. 例如,当流量完成时通知:

```js
// This callback will be called when a the current user/group changes state in any flow
const callback = (updatedFlow, previousFlow) => {
  console.log('Flow state changed:', flow.isCompleted)
  console.log('Step state changed:', flow.steps.get('STEP_ID').isCompleted)
};

frigade.onStateChange(callback);
// To remove the callback use:
frigade.removeOnFlowStateChangeHandler(callback);
```

当特定流量变化状态时,可以注册特定事件处理器以通知. 例如,当流量完成时通知:

```js
// This callback will be called when a the current user/group changes state in the flow with id FLOW_ID
const flow = await frigade.getFlow('FLOW_ID')
const callback = (updatedFlow, previousFlow) => {
  console.log('Flow state changed:', flow.isCompleted)
  console.log('Step state changed:', flow.steps.get('STEP_ID').isCompleted)
};
flow.onStateChange(callback);
```

仅针对流动中的特定步骤,使用:

```js
// This callback will be called when a the current user/group changes state in the flow with id FLOW_ID and step with id STEP_ID
const flow = await frigade.getFlow('FLOW_ID')
const step = flow.steps.get('STEP_ID')
const callback = (updatedStep, previousStep) => {
  console.log('Step state changed:', step.isCompleted)
};
step.onStateChange(callback);
```

## 跨平台支持

SDK的所有非UI相关功能在所有JavaScript环境中工作(Node.js,浏览器,React Introduct等).

## 类型脚本支持

此套件包含类型脚本定义 `frigade` 对象.

## 关于弗里加德

[果冻](https://frigade.com/) 是一个开发商先行的平台,用于在机上建造优质产品。 一个强大的, 灵活的 API 和本地的 SDK 允许您更快地在 10x 上建机, 更容易的实验, 并驱动客户 成功吗.

Frigade支持一系列的使用案例,例如:

-   **登记**: 尽量增加用户通过您签名的流量, 并使用美丽的解释器, 进步 条条和表格.
-   **激活**: 转换更多的客户,方法是通过一系列适合其角色的键入项目, 权限,或目标.
-   **收 养**: 向受众介绍与本地热点、工具提示、旅游和 交互式产品指南.
-   **参与**:保持活跃客户的接触,宣布新的产品特性,并创建特定生命周期 休眠或休眠的客户重新登船.
-   **保留**: 通过在正确的时间提供正确的内容,并通过要求用户 对产品的反馈.

# 特征

**构成部分库**

用于搭载高质量用户的无型即成组件,速度快. 登入清单、工具提示、, 产品走过,还有更多. [见组件](https://frigade.com/components)

**一体化**

与分会,Mixpanel,Posthog的结合,以及更多对动力瞄准,分析,和通信的结合.

**内容管理**

轻量级CMS内置以更新并测试登机副本和内容.

**版本**

Frigade使得管理多个版本的搭载在中转和生产之间变得容易. 重审以前的版本 上岗看他们的表现和做的改进.

**客户行程**

Frigade 自动跟踪状态管理和登入进度. 让你的团队全心全意进入 客户旅行,并使用Frigade来启动自动化工作流程.

要多学多学,就去参观 [frigade.com (英语)](https://frigade.com/)

## 常见问题

### @frigade/js 是什么？

官方Javascript SDK for Frigade\. \(原始内容存档于2018-10-12\)\.

### 如何安装 @frigade/js？

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

### @frigade/js 支持 TypeScript 吗？

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

### @frigade/js 支持 ESM 还是 CommonJS？

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

### @frigade/js 可以商用吗？

@frigade/js 使用 ELv2 许可。声明的许可为 ELv2，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @frigade/js 的下载量有多少？

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

### @frigade/js 还在维护吗？

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