# @flare-engine/analytics 中文文档

规范地址：https://npmcn.com/package/%40flare-engine/analytics/

版本：0\.4\.12
npm 元数据更新时间：2026-11-12T19:46:07.061Z
中文译文更新时间：2026-11-14T22:50:04.769Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：43 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- peer 依赖：react \>=19\.0\.0
- 首次发布：2026-06-09T16:19:36.921Z
- 最新版本发布：2026-11-12T19:46:06.660Z
- 近 30 天下载量：2255（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

分析提供者接口(消费者提供适配器)

## 安装

```sh
npm install @flare-engine/analytics
```

也可以使用：`pnpm add @flare-engine/analytics`、`yarn add @flare-engine/analytics`、`bun add @flare-engine/analytics`

## README

# @flare-engine/分析

类型 `AnalyticsProvider` 接口 + `NoopAnalyticsProvider` +反应上下文,加 `createMemoryAnalytics` 编号 : `createConsoleAnalytics` – 测试和dev的本地供应商. 混凝土平台适配器(PostHog, Amplitude, section, Firebase)是后发射; 在此之前在应用边界上自线.

## 安装

```sh
bun add @flare-engine/analytics
```

## 使用量

```tsx
import {
  AnalyticsContext,
  useAnalytics,
  NoopAnalyticsProvider,
} from '@flare-engine/analytics';

export function App() {
  return (
    <AnalyticsContext.Provider value={NoopAnalyticsProvider}>
      {/* ... */}
    </AnalyticsContext.Provider>
  );
}
```

`useAnalytics()` 返回活动提供者。 这个 `AnalyticsProvider` 表面为 `track(event, props?)`, (中文(简体) ), `identify(userId, traits?)`, (中文(简体) ), `screen(name, props?)`,以及 `flush()` - 全都是动脉 盗用 `NoopAnalyticsProvider` 对于另一个供应商来说,不需要改变消费者.

## 当地供应商

`createMemoryAnalytics(opts?)` 将事件捕获到一个可以检查的有界限的环缓冲器中——在测试中坚持行为的理想:

```ts
import { createMemoryAnalytics } from '@flare-engine/analytics';

const analytics = createMemoryAnalytics({ capacity: 100 });
await analytics.track('level_start', { zone: 1 });
await analytics.screen('hud');
analytics.getEvents();
// [{ type: 'track', name: 'level_start', props: { zone: 1 }, timestamp },
//  { type: 'screen', name: 'hud', timestamp }]
```

-   每一次通话记录匹配 `AnalyticsEvent` 变种. 当缓冲器满了( W)`capacity`默认值 `256`,夹住 `>= 1`)最古老的事件被放弃.
-   `getEvents()` 返回最古老的防御副本 ; `clear()` 取出空来. 时间戳来自注射器 `now` (默认) `Date.now`) (中文(简体) ). `flush()` 是个禁忌.

`createConsoleAnalytics(opts?)` 日志每个事件到被注入的汇( 默认) `console.log`,作为 `log('[analytics]', event)` ——本地运行的零设置提供者.

`AnalyticsEvent` 被歧视的工会 `type` (单位:千美元)`'track'` 编号 : `'identify'` 编号 : `'screen'`)——事件塑造了两个本地提供者的记录.

## 内置后退

在 CI 或 dev 构建中没有平台证书, 请选择 `NoopAnalyticsProvider` (或当地供应商)在您自己的嵌入式旗帜后方,所以在真实的资质存在之前,任何事物都不要触碰本地的SDK.

## 常见问题

### @flare-engine/analytics 是什么？

分析提供者接口\(消费者提供适配器\)

### 如何安装 @flare-engine/analytics？

在项目目录运行 npm install @flare-engine/analytics，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flare-engine/analytics 支持 TypeScript 吗？

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

### @flare-engine/analytics 支持 ESM 还是 CommonJS？

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

### @flare-engine/analytics 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @flare-engine/analytics 可以商用吗？

@flare-engine/analytics 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @flare-engine/analytics 的下载量有多少？

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

### @flare-engine/analytics 还在维护吗？

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