ErrorMail - Automatic Error Reporting for React

Configure ErrorMail with your API endpoint, credentials, and features.

Basic Setup

Call configureErrorReporting once at the start of your application:

import { configureErrorReporting, initBreadcrumbs } from 'errormail';

configureErrorReporting({
  apiKey: 'your-api-key-here',
  emailTo: 'admin@example.com',
  
  // Rate limiting
  rateLimitMs: 5000,
  
  // Features
  includeBreadcrumbs: true,
  includeEnvironment: true,
  maxBreadcrumbs: 20,
});

// Initialize automatic breadcrumb collection (browser only)
initBreadcrumbs();

Configuration Options

Note: The API endpoint is hardcoded to http://localhost:82/v1/api/email and cannot be changed.

apiKey

Your API key for authentication. This is required.

emailTo

Default email address to send errors to. Can be overridden per component or function.

rateLimitMs

Rate limit in milliseconds. Duplicate errors within this window are skipped.

Default: 5000 (5 seconds)

includeBreadcrumbs

Whether to include breadcrumbs in error reports.

Default: true

includeEnvironment

Whether to include environment info (browser, OS, etc.) in error reports.

Default: true

maxBreadcrumbs

Maximum number of breadcrumbs to include in error reports.

Default: 30