# @aptabase/web 中文文档

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

版本：0\.5\.0
npm 元数据更新时间：2026-01-21T07:17:40.858Z
中文译文更新时间：2026-11-06T12:56:08.283Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：30.4 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-04-02T12:09:36.491Z
- 最新版本发布：2026-01-21T07:17:40.738Z
- 近 30 天下载量：12554（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 1 个）

## 中文简介

JavaScript SDK for Aptabase: 开放源代码, 隐私第一和简单分析, 用于移动、 桌面和网络应用

## 安装

```sh
npm install @aptabase/web
```

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

## README

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

# 网络应用的 Appabase SDK

一个很小的 SDK ( 1 kB) 用 Aptabase 为您的网络应用程序提供设备, 一个开放源码, 用于移动、 桌面和网络应用程序的隐私第一和简单分析 .

建立反应应用程序? 使用 `@aptabase/react` 软件包.

> 👉 **重要性**
> 
> 这个SDK是给 **网络应用程序**,而不是网站。 有一种微妙而重要的区别. 一个网络应用程序通常会有更多的互动性,当用户与它互动时不会导致一个完整页面再加载. 它经常被称作 **单页应用程序**另一方面,网站更注重内容,如营销网站、登陆网页、博客等。 虽然您肯定可以使用 Aptabase 来跟踪网站上的事件, 但请注意每个页面重载将被视为一个新会话 .

## 安装

使用 npm 或您喜欢的 JavaScript 软件包管理器安装 SDK

```bash
npm add @aptabase/web
```

## 使用量

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

使用您的 SDK 初始化 `App Key`数字 :

```js
import { init } from '@aptabase/web';

init('<YOUR_APP_KEY>'); // 👈 this is where you enter your App Key
```

Init 函数还支持一个可选的第二个参数,它是一个带有 `appVersion` 属性.

如何获得你的应用软件版本,由您决定,但一般建议使用你的捆绑器(如Webpack,Vite,Rollup等)在构建时注入数值. 或者您也可以手动传递.

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

```js
import { trackEvent } from '@aptabase/web';

trackEvent('connect_click'); // An event with no properties
trackEvent('play_music', { name: 'Here comes the sun' }); // An event with a custom property
```

几个重要说明:

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

## 常见问题

### @aptabase/web 是什么？

JavaScript SDK for Aptabase: 开放源代码, 隐私第一和简单分析, 用于移动、 桌面和网络应用

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

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

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

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

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

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

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

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

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

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

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

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