# @aptabase/electron 中文文档

规范地址：https://npmcn.com/package/%40aptabase/electron/

版本：0\.3\.1
npm 元数据更新时间：2024-05-31T13:12:32.288Z
中文译文更新时间：2026-11-06T12:56:22.415Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：43.3 kB，15 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：electron \>= 3\.x
- 首次发布：2023-05-24T06:16:20.111Z
- 最新版本发布：2023-11-04T19:13:56.587Z
- 近 30 天下载量：9137（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

Aptabase 电子 SDK: 开放源代码、 移动、 桌面和网络应用程序的隐私第一和简单分析

## 安装

```sh
npm install @aptabase/electron
```

也可以使用：`pnpm add @aptabase/electron`、`yarn add @aptabase/electron`、`bun add @aptabase/electron`

## README

![Aptabase](https://aptabase.com/og.png)

# Aptabase 电子 SDK

以 Aptabase 、 开源、 隐私第一 、 移动、 桌面和 Web Apps 的简单分析设备为电子应用设备.

## 安装

使用您的首选 JavaScript 软件包管理器安装 SDK

```bash
npm add @aptabase/electron
```

## 使用量

首先,你必须得到你的 `App Key` 从Aptabase可以找到它 `Instructions` 菜单.

在您的电子主程序上, 在应用程序准备好前初始化 SDK :

```js
import { initialize } from "@aptabase/electron/main";

initialize("<YOUR_APP_KEY>"); // 👈 this is where you enter your App Key

app.whenReady().then(() => {
  // ... the rest of your app initialization code
});
```

之后,你可以开始跟踪事件 `trackEvent`数字 :

```js
import { trackEvent } from "@aptabase/electron/renderer";

trackEvent("app_started"); // An event with no properties
trackEvent("screen_view", { name: "Settings" }); // An event with a custom property
```

**注:** 这个 `trackEvent` 函数可以在单独的导入路径下使用,这取决于您要从何处跟踪事件.

-   从 `@aptabase/electron/renderer` 以跟踪 `renderer` 进程
-   从 `@aptabase/electron/main` 以跟踪 `main` 进程

> 以上指示被推荐为电机的现代设置. 关于Electron的旧版本,请参见: [备选说明](https://github.com/aptabase/aptabase-electron/discussions/1)。 。 。 .

几个重要说明:

1.  SDK会用一些有用的信息自动增强事件,如OS,app版本等.
2.  你控制着被送到阿普塔基地的东西 此 SDK 不自动跟踪任何事件, 您需要呼叫 `trackEvent` 手动.
    -   因此,一般建议在启动时至少跟踪一个事件
3.  你不需要等待着 `trackEvent` 函数,会在后台运行.
4.  只允许自定义属性上的字符串和数字值

## 常见问题

### @aptabase/electron 是什么？

Aptabase 电子 SDK: 开放源代码、 移动、 桌面和网络应用程序的隐私第一和简单分析

### 如何安装 @aptabase/electron？

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

### @aptabase/electron 支持 TypeScript 吗？

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

### @aptabase/electron 支持 ESM 还是 CommonJS？

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

### @aptabase/electron 可以商用吗？

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

### @aptabase/electron 的下载量有多少？

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

### @aptabase/electron 还在维护吗？

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