# @datarangers/sdk-javascript 中文文档

规范地址：https://npmcn.com/package/%40datarangers/sdk-javascript/

版本：0\.1\.7
npm 元数据更新时间：2026-10-21T06:28:04.515Z
中文译文更新时间：2026-11-11T15:20:44.036Z
软件包许可：SEE LICENSE IN LICENSE

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

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

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

- 包体积（解压后）：1.3 MB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2022-12-13T04:25:37.390Z
- 最新版本发布：2026-10-21T06:28:04.254Z
- 近 30 天下载量：15184（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 4 个）

## 中文简介

简体中文 [联合国](https://npmcn.com/package/%40datarangers/sdk-javascript/README.md) {\\fn方正粗倩简体\\fs12\\an8\\1cHFFFF00\\b0} `DataRangers SDK - Web端` □ □ □ SDK

## 安装

```sh
npm install @datarangers/sdk-javascript
```

也可以使用：`pnpm add @datarangers/sdk-javascript`、`yarn add @datarangers/sdk-javascript`、`bun add @datarangers/sdk-javascript`

## README

简体中文 | [English](https://npmcn.com/package/%40datarangers/sdk-javascript/README.md)

# `DataRangers SDK - Web端`

## 构建SDK

```javascript
npm install 
npm run build
```

## 使用方式

### 1\. 在你的js文件中初始化SDK

```javascript
const SDK = require('@datarangers/sdk-javascript');

SDK.init({
  app_id: 1234, // 替换成你申请的 "APP_ID"
  channel: 'cn', // 选择你要上报的区域，cn: 国内 sg: 新加坡 va:美东
  log: true, // 是否打印日志
});

SDK.config({
  username: 'xxx', // 你想要上报一个username的公共属性
});

SDK.start(); // 初始化完成，事件开始上报

```

### 2\. 上报自定义用户事件

```javascript
// 比如上报一个'play_video'视频播放的事件
SDK.event('play_video', {
  title: 'Here is the video title',
});
```

### 3\. 使用当前登录用户的信息做为唯一标识来进行上报

```javascript
// 可以在用户登录后获取带有唯一性的标识来设置给user_unique_id
 SDK.config({
    user_unique_id: 'zhangsan', // 用户唯一标识，可以是你的系统登录用户id
  });
```

## 常见问题

### @datarangers/sdk-javascript 是什么？

简体中文 联合国 \{\\fn方正粗倩简体\\fs12\\an8\\1cHFFFF00\\b0\} DataRangers SDK - Web端 □ □ □ SDK

### 如何安装 @datarangers/sdk-javascript？

在项目目录运行 npm install @datarangers/sdk-javascript，或使用 pnpm add / yarn add / bun add。

### @datarangers/sdk-javascript 支持 TypeScript 吗？

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

### @datarangers/sdk-javascript 支持 ESM 还是 CommonJS？

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

### @datarangers/sdk-javascript 可以商用吗？

@datarangers/sdk-javascript 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @datarangers/sdk-javascript 的下载量有多少？

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

### @datarangers/sdk-javascript 还在维护吗？

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