Fundebug JavaScript Error Monitoring

Common errors

Warnings

Install

Imports

• fundebug
  wrong

  const fundebug = require('fundebug-javascript');

  correct

  import * as fundebug from 'fundebug-javascript';

  While CommonJS `require` works, ESM `import * as` is the recommended pattern, especially since v2.0.0 which added comprehensive TypeScript support. The library exports a default object containing its methods.

• fundebug.init
  wrong

  fundebug.apikey = 'YOUR_APIKEY';

  correct

  fundebug.init({ apikey: 'YOUR_APIKEY' });

  Since v2.0.0, `fundebug.init()` is the recommended and TypeScript-friendly method for configuration, including setting the API key. Direct assignment to `fundebug.apikey` might still work but is less robust and not type-safe.

• FundebugEvent

  import type { FundebugEvent } from 'fundebug-javascript';

  The package ships with TypeScript types. For type-only imports, use `import type` to avoid bundling unnecessary runtime code, adhering to modern TypeScript practices. This is useful for defining custom error event structures or handlers.

Quickstart

This quickstart demonstrates how to initialize Fundebug with an API key and custom metadata, simulate both uncaught and caught errors, and highlight optional data collection settings.

import * as fundebug from 'fundebug-javascript';

const FUNDEBUG_API_KEY = process.env.FUNDEBUG_API_KEY ?? '';

// Initialize Fundebug with your API key and other optional configurations
fundebug.init({
  apikey: FUNDEBUG_API_KEY,
  metaData: {  // Example of custom metadata
    user: { id: 'user-123', name: 'John Doe' },
    appVersion: '1.0.0'
  },
  // Opt-in to monitor HTTP request bodies for detailed debugging
  monitorHttpBody: true, // Introduced in v2.8.4
  // To silently ignore performance data on errors
  silentPerformance: false // Introduced in v1.5.0
});

console.log('Fundebug initialized. Try triggering an error...');

// Simulate a JavaScript error
document.addEventListener('DOMContentLoaded', () => {
  const btn = document.createElement('button');
  btn.textContent = 'Trigger Error';
  document.body.appendChild(btn);
  btn.onclick = () => {
    throw new Error('This is a simulated error from Fundebug quickstart!');
  };
});

// Manually report an error
try {
  // Some risky operation
  const data: any = null;
  data.property.doSomething();
} catch (error: any) {
  fundebug.notifyError(error, { customInfo: 'Caught error in try-catch block' });
}