📌
Introduction
🍎
Education
🏢
Administration
🔧
Updates
Deno
Introduction
BugSplat-Deno is a TypeScript error reporting system for Deno applications. Before integrating a new BugSplat SDK with your application, make sure to review the Getting Started resources and complete the simple startup tasks listed below.
Need any further help? Check out the full BugSplat documentation here, or email the team at [email protected].
Configuration
To add the bugsplat package to your application, run the following shell command at the root of your project’s directory:
1
import { BugSplat } from 'https://deno.land/x/[email protected]/bugsplat.ts';
Copied!
Create a new instance of the BugSplat class with the name of your BugSplat database, the name of your application and the version of your application:
1
const bugsplat = new BugSplat("DatabaseName", "AppName", "1.0.0.0");
Copied!
Use bugsplat-deno to capture errors that originate inside of try-catch blocks:
1
try {
2
throw new Error("BugSplat");
3
} catch (error) {
4
await bugsplat.post(error);
5
}
Copied!
You can also use bugsplat-deno to post errors from non-fatal promise rejections:
1
Promise.reject(new Error("BugSplat!")).catch(error => bugsplat.post(error, {}));
Copied!
Deno Crashes
Deno Crash
That’s it! Your application is now configured to post crash reports to BugSplat.
API
In addition to the configuration demonstrated above, there are a few public methods that can be used to customize your BugSplat integration:
1
bugsplat.setDefaultAppKey(appKey); // Additional metadata that can be queried via BugSplats web application
2
bugsplat.setDefaultUser(user); // The name or id of your user
3
bugsplat.setDefaultEmail(email); // The email of your user
4
bugsplat.setDefaultDescription(description); // Additional info about your crash that gets reset after every post
5
async bugsplat.post(error, options); // Posts an arbitrary Error object to BugSplat
6
// If the values options.appKey, options.user, options.email, options.description are set the corresponding default values will be overwritten
7
// Returns a promise that resolves with properties: error (if there was an error posting to BugSplat), response (the response from the BugSplat crash post API), and original (the error passed by bugsplat.post)
8
view rawbugsplat-deno-api.js hosted with ❤ by GitHub
9
Contributing
Copied!
Contributing
BugSplat loves open-source software! Please check out our project on GitHub and send us a Pull Request.
Last modified 24d ago
Copy link