https://github.com/bugsplat-git/bugsplat-js-api-client
⚙️🧩🧑💻 TS/JS client for consuming BugSplat APIs
https://github.com/bugsplat-git/bugsplat-js-api-client
api apm bugsplat client crash error javascript reporting typescript
Last synced: 3 months ago
JSON representation
⚙️🧩🧑💻 TS/JS client for consuming BugSplat APIs
- Host: GitHub
- URL: https://github.com/bugsplat-git/bugsplat-js-api-client
- Owner: BugSplat-Git
- License: mit
- Created: 2021-05-25T21:55:20.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T00:49:05.000Z (4 months ago)
- Last Synced: 2025-01-30T00:51:07.168Z (4 months ago)
- Topics: api, apm, bugsplat, client, crash, error, javascript, reporting, typescript
- Language: TypeScript
- Homepage: https://docs.bugsplat.com/introduction/development/web-services/api
- Size: 1.38 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bugsplat.com)
#
BugSplat
### **Crash and error reporting built for busy developers.**
## 👋 Introduction
[@bugsplat/js-api-client](https://www.npmjs.com/package/@bugsplat/js-api-client) is a set of JavaScript client libraries for consuming the BugSplat API. This package is compatible in both browser and node environments as it provides ESM and CommonJS builds for each environment respectively. Additionally this package is implemented in TypeScript and the distributed builds include definition files and source maps.
## 🏗 Installation
Install [@bugsplat/js-api-client](https://www.npmjs.com/package/@bugsplat/js-api-client) via npm. This package currently requires Node.js 18 or later.
```sh
npm i @bugsplat/js-api-client
```
If you need to use a version of Node.js that's older than 18, you can install `@bugsplat/[email protected]`.
## ⚙️ Configuration
Import `BugSplatApiClient` and `Environment` from `@bugsplat\js-api-client`
```ts
import { BugSplatApiClient, Environment } from '@bugsplat/js-api-client';
```
Create an authenticated `BugSplatApiClient` following the steps below. Authentication is slightly different depending on if you are use `@bugsplat/js-api-client` in a Node.js or Web Browser environment. The method used to authenticate also depends on if you already have access to the user's email and password, or if you have to prompt for it at a later time.
The `host` value used to create a new instance of `BugSplatApiClient` is `https://app.bugsplat.com` for most scenarios. When using this library to upload a crash reports the host value will be `https://{{database}}.bugsplat.com`.
### Node.js
The static factory function `createAuthenticatedClientForNode` can be used to return an authenticated instance of `BugSplatApiClient` in Node.js environments.
```ts
const bugsplat = await BugSplatApiClient.createAuthenticatedClientForNode(email, password, host);
```
If you need to authenticate at a later time, you can create an instance of `BugSplatApiClient` and call `login` manually.
```ts
const bugsplat = new BugSplatApiClient(host, Environment.Node);
await bugsplat.login(email, password);
```
### Web Browser
The static factory function `createAuthenticatedClientForWebBrowser` can be used to return an authenticated instance of `BugSplatApiClient`.
```ts
const bugsplat = await BugSplatApiClient.createAuthenticatedClientForBrowser(email, password, host);
```
If you need to authenticate at a later time, you can create an instance of `BugSplatApiClient` and call `login` manually.
```ts
const bugsplat = new BugSplatApiClient(host, Environment.WebBrowser);
await bugsplat.login(email, password);
```
## ⌨️ Usage
Create an instance of `CrashApiClient` or any of the API clients and pass a reference to the `BugSplatApiClient` instance
```ts
const client = new CrashApiClient(bugsplat);
```
The API clients are built to automatically parse responses from BugSplat into objects that can be used by your application
```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' }
// ]
// }
// ...
```
## 🧑💻 Contributing
BugSplat ❤️s open source! If you feel that this package can be improved, please open an [Issue](https://github.com/BugSplat-Git/bugsplat-js-api-client/issues). If you have an awesome new feature you'd like to implement, we'd love to merge your [Pull Request](https://github.com/BugSplat-Git/bugsplat-js-api-client/pulls). You can also send us an [email](mailto:[email protected]), join us on [Discord](https://discord.gg/K4KjjRV5ve), or message us via the in-app chat on [bugsplat.com](https://bugsplat.com).