Skip to main content
Install the Proliferate JavaScript SDK to start capturing errors and session replays in your browser application.

Package Installation

npm install @proliferate/sdk

Quick Setup

import Proliferate from '@proliferate/sdk';

Proliferate.init({
  endpoint: 'https://api.yourapp.com/api/v1/errors',
  apiKey: 'pk_your_api_key',
  environment: 'production',
});

Package Exports

The SDK provides two entry points:
Import PathDescription
@proliferate/sdkCore SDK with error tracking, session replay, logging, and breadcrumbs
@proliferate/sdk/reactReact integration with Error Boundary components
// Core SDK
import Proliferate from '@proliferate/sdk';

// React components
import {
  ProliferateErrorBoundary,
  withErrorBoundary,
  useErrorBoundary
} from '@proliferate/sdk/react';

Browser Compatibility

The SDK supports all modern browsers:
BrowserMinimum Version
Chrome80+
Firefox78+
Safari14+
Edge80+

Requirements

The SDK uses modern JavaScript features including optional chaining and nullish coalescing.
Used for generating event IDs. Falls back to a polyfill for older browsers.
Required for sending events to the backend.

Node.js Support

The SDK is designed for browser environments. For server-side error tracking, use the Python SDK.
The SDK requires Node.js 18+ for build-time operations (TypeScript compilation, bundling).

Dependencies

The SDK has minimal dependencies:
PackagePurpose
rrwebSession replay recording
React is an optional peer dependency, only required if using @proliferate/sdk/react.

Next Steps