# @churnassassin/sentry-beacon 中文文档

规范地址：https://npmcn.com/package/%40churnassassin/sentry-beacon/

版本：1\.0\.3
npm 元数据更新时间：2025-08-23T19:47:15.722Z
中文译文更新时间：2026-11-09T19:37:58.444Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40churnassassin/sentry-beacon
原文对照：https://npmcn.com/package/%40churnassassin/sentry-beacon/?lang=original

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

- 包体积（解压后）：4.5 kB，3 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2025-07-28T14:48:37.110Z
- 最新版本发布：2025-08-23T19:47:15.531Z
- 近 30 天下载量：1774（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

Churn刺客哨灯塔追踪器的国家预防机制装载器

## 安装

```sh
npm install @churnassassin/sentry-beacon
```

也可以使用：`pnpm add @churnassassin/sentry-beacon`、`yarn add @churnassassin/sentry-beacon`、`bun add @churnassassin/sentry-beacon`

## README

# @churnassin/哨兵-猎鹰

国家防范机制正式装载器 **哨兵灯塔** 财务报告和审定财务报表 **哨兵小组** 用于跟踪的代理 [楚恩刺客](https://churnassassin.com/)。 。 。 .

此轻量级模块允许您从您的前端 JavaScript app (React, Vue等) 中初始化客户活动跟踪,而无需手动嵌入 `<script>` 标签.

* * *

## \* 安装

```bash
npm install @churnassassin/sentry-beacon
```

* * *

## 使用量

导入并初始化您前端app中的信标( 例如 React, Vue, plain JS):

```js
import { initSentryBeacon } from '@churnassassin/sentry-beacon'

initSentryBeacon({
token: "[Provided By Churn Assassin]",
useragent: navigator.userAgent,
activity: window.location.pathname,    // or other variable containing the event
qs: window.location.search,            // or other variable containing event details
company_name: 'ABC-123',               // Alpha-numeric company name
companyid: 'ABC-123',                  // Alpha-numeric company id
enduser_email: 'user@example.com',     // email of end user logged into your app
enduser_firstname: 'Jane',             // first name of end user logged into your app
enduser_lastname: 'Doe',               // last name of end user logged into your app
enduserid: 'user-789',                 // unique id of end user logged into your app
productid: '1',                        // Numeric, default: 1
platformid: '2'                        // Numeric, default: 2
})
```

* * *

## ~ 做什麽 ~

当调用时, 此函数 :

1.  指定全局性 `window.assassindata` 对象,包含所有用户/会话元数据.
2.  注入哨塔脚本 :  
    `https://api.churnassassin.com/static/js/churnassassin.js`
3.  注入哨兵面板脚本( 可选的 UI 模块) :  
    `https://api.churnassassin.com/static/js/engagement.js`

这些脚本然后开始向Churn刺客报告你的应用中的使用和约定活动.

* * *

## 页:1

-   确保 `token` 和用户专用字段根据当前登录的用户动态注入.
-   脚本每页负载只注射一次(重复保护是内置的).
-   此模块仅意在浏览器中运行(不是SSR).
-   SPA's(单页应用程序): 应当使用自定义路由器来填充 \[活 和 \[qs\] 属性

* * *

## ++ 辅助

需要帮忙吗? 电子邮件 [支持@churnassassin.com](mailto:support@churnassassin.com) 或者联系你的登机专家.

* * *

## 许可证

麻省理工学院 布莱恩·波拉克夫/丘恩刺客

## 常见问题

### @churnassassin/sentry-beacon 是什么？

Churn刺客哨灯塔追踪器的国家预防机制装载器

### 如何安装 @churnassassin/sentry-beacon？

在项目目录运行 npm install @churnassassin/sentry-beacon，或使用 pnpm add / yarn add / bun add。

### @churnassassin/sentry-beacon 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/churnassassin\_\_sentry-beacon 是否存在。

### @churnassassin/sentry-beacon 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @churnassassin/sentry-beacon 可以商用吗？

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

### @churnassassin/sentry-beacon 的下载量有多少？

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

### @churnassassin/sentry-beacon 还在维护吗？

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