# @bugsplat/js-api-client 中文文档

规范地址：https://npmcn.com/package/%40bugsplat/js-api-client/

版本：15\.8\.0
npm 元数据更新时间：2026-10-05T15:50:37.259Z
中文译文更新时间：2026-11-08T19:07:48.655Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bugsplat/js-api-client
原文对照：https://npmcn.com/package/%40bugsplat/js-api-client/?lang=original
项目主页：https://github.com/BugSplat-Git/bugsplat-js-api-client#readme
源码仓库：https://github.com/BugSplat-Git/bugsplat-js-api-client

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

- 包体积（解压后）：528 kB，477 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2021-06-01T18:36:16.575Z
- 最新版本发布：2026-10-05T15:50:37.092Z
- 近 30 天下载量：4334（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：95（近 12 个月 20 个）

## 中文简介

JS客户端 消费 BugSplate API

## 安装

```sh
npm install @bugsplat/js-api-client
```

也可以使用：`pnpm add @bugsplat/js-api-client`、`yarn add @bugsplat/js-api-client`、`bun add @bugsplat/js-api-client`

## README

[![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)](https://bugsplat.com/)  

# 

BugSpla

### **

为繁忙的开发者构建了崩溃和错误报告 .

**

 [![Follow @bugsplatco on Twitter](https://img.shields.io/twitter/follow/bugsplatco?label=Follow%20BugSplat&style=social)](https://twitter.com/BugSplatCo)[![Join BugSplat on Discord](https://img.shields.io/discord/664965194799251487?label=Join%20Discord&logo=Discord&style=social)](https://discord.gg/K4KjjRV5ve)

## 导 言

[@ bugsplat/js- api- 客户端](https://www.npmjs.com/package/@bugsplat/js-api-client) 是一套 JavaScript 客户端库,用于消耗 BugSplate API 。 这个软件包在浏览器和节点环境中都是相容的,因为它分别为每一种环境提供了无害环境管理和共同JS构建。 此外,该软件包在TypeScript中执行,所分发的建筑包括定义文件和源图.

## \* 安装

安装 [@ bugsplat/js- api- 客户端](https://www.npmjs.com/package/@bugsplat/js-api-client) 通过npm。 此套件目前需要Node.js 18或更晚.

```sh
npm i @bugsplat/js-api-client
```

如果需要使用已经超过18岁的节点Js版本,可以安装 `@bugsplat/js-api-client@2.1.3`。 。 。 .

## QQ 配置

导入 `BugSplatApiClient` 财务报告和审定财务报表 `Environment` 从 `@bugsplat\js-api-client`

```ts
import { BugSplatApiClient, Environment } from '@bugsplat/js-api-client';
```

创建认证 `BugSplatApiClient` 遵循以下步骤。 认证视是否使用而略有不同 `@bugsplat/js-api-client` 在节点.js或 Web 浏览器环境中。 用于认证的方法还取决于您是否已经可以访问用户的电子邮件和密码,或者您是否必须在以后的某个时间及时进行认证.

这个 `host` 用于创建新实例的值 `BugSplatApiClient` 实值 `https://app.bugsplat.com` 对于大多数情景。 当使用此库上传崩溃报告时, 主机值将会是 `https://{{database}}.bugsplat.com`。 。 。 .

### 节点.js

静电厂的功能 `createAuthenticatedClientForNode` 可用于返回经认证的 `BugSplatApiClient` 在Node.js环境中.

```ts
const bugsplat = await BugSplatApiClient.createAuthenticatedClientForNode(email, password, host);
```

如果您以后需要认证, 您可以创建实例 `BugSplatApiClient` 打电话 `login` 手动.

```ts
const bugsplat = new BugSplatApiClient(host, Environment.Node);
await bugsplat.login(email, password);
```

### 网页浏览器

静电厂的功能 `createAuthenticatedClientForWebBrowser` 可用于返回经认证的 `BugSplatApiClient`。 。 。 .

```ts
const bugsplat = await BugSplatApiClient.createAuthenticatedClientForBrowser(email, password, host);
```

如果您以后需要认证, 您可以创建实例 `BugSplatApiClient` 打电话 `login` 手动.

```ts
const bugsplat = new BugSplatApiClient(host, Environment.WebBrowser);
await bugsplat.login(email, password);
```

## 使用量

创建实例 `CrashApiClient` 或任何API客户端,并通过引用 `BugSplatApiClient` 实例

```ts
const client = new CrashApiClient(bugsplat);
```

API 客户端的构建将自动从 BugSplate 解析到您应用程序可以使用的对象

```ts
const database = 'Fred';
const id = 100389;
const crash = await client.getCrashById(database, id);

for (const stackFrame of crash.thread.stackFrames) {
  console.log(stackFrame);
}

// StackFrame {
//     fileName: 'C:\\BugSplat\\samples\\myConsoleCrasher\\myConsoleCrasher.cpp',
//     functionName: 'myConsoleCrasher!MemoryException',
//     lineNumber: 150,
//     stackFrameLevel: 1,
//     arguments: [],
//     locals: []
// }
// StackFrame {
//     fileName: 'C:\\BugSplat\\samples\\myConsoleCrasher\\myConsoleCrasher.cpp',
//     functionName: 'myConsoleCrasher!wmain',
//     lineNumber: 84,
//     stackFrameLevel: 2,
//     arguments: [
//       { variable: 'int argc', value: '0n2' },
//       { variable: 'wchar_t ** argv', value: '0x0125ef20' }
//     ],
//     locals: [
//       { variable: 'int i', value: '0n1' },
//       { variable: 'int argc', value: '0n2' },
//       { variable: 'wchar_t ** argv', value: '0x0125ef20' }
//     ]
// }
// ...
```

## 捐款

BugSplate QQ开源! 如果您觉得这个软件包可以改进,请打开一个 [问题](https://github.com/BugSplat-Git/bugsplat-js-api-client/issues)如果你有一个令人赞叹的新功能,你想执行, 我们愿意合并你的 [拉请求](https://github.com/BugSplat-Git/bugsplat-js-api-client/pulls)。您也可以给我们发送 [电子邮件](mailto:support@bugsplat.com),加入我们 [解析器](https://discord.gg/K4KjjRV5ve),或者通过 app 聊天在 [bugsplat.com (英语)](https://bugsplat.com/)。 。 。 .

## 常见问题

### @bugsplat/js-api-client 是什么？

JS客户端 消费 BugSplate API

### 如何安装 @bugsplat/js-api-client？

在项目目录运行 npm install @bugsplat/js-api-client，或使用 pnpm add / yarn add / bun add。

### @bugsplat/js-api-client 支持 TypeScript 吗？

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

### @bugsplat/js-api-client 支持 ESM 还是 CommonJS？

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

### @bugsplat/js-api-client 可以商用吗？

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

### @bugsplat/js-api-client 的下载量有多少？

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

### @bugsplat/js-api-client 还在维护吗？

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