BugSpla

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

导 言

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

* 安装

安装 @ bugsplat/js- api- 客户端 通过npm。 此套件目前需要Node.js 18或更晚.

npm i @bugsplat/js-api-client

如果需要使用已经超过18岁的节点Js版本,可以安装 @bugsplat/[email protected]。 。 。 .

QQ 配置

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

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环境中.

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

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

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

网页浏览器

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

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

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

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

使用量

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

const client = new CrashApiClient(bugsplat);

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

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开源! 如果您觉得这个软件包可以改进,请打开一个 问题如果你有一个令人赞叹的新功能,你想执行, 我们愿意合并你的 拉请求。您也可以给我们发送 电子邮件,加入我们 解析器,或者通过 app 聊天在 bugsplat.com (英语)。 。 。 .