@pulseboard/react-native

Official React Native SDK for PulseBoard — mobile app observability platform by Aenexar.

Installation

npm install @pulseboard/react-native

iOS

npx pod-install

Android

No additional steps required — autolinking handles it.

Quick Start

import { PulseBoard } from "@pulseboard/react-native";

// Initialise once at app entry point
PulseBoard.init({
  host: "https://your-backend-url.com",
  apiKey: "your-project-api-key",
  app: {
    version: "1.0.0",
    buildNumber: "1",
    environment: "production",
  },
  debug: false,
  autoCapture: true,
  flushInterval: 5000,
  maxQueueSize: 100,
});

API Reference

Initialisation

PulseBoard.init(config: SDKConfig): void

User

PulseBoard.identify(user: UserContext): void
PulseBoard.clearUser(): void

Events

PulseBoard.track(name: string, options?: TrackOptions): void
PulseBoard.metric(name: string, value: number, options?: TrackOptions): void
PulseBoard.captureError(error: Error, options?: CaptureErrorOptions): void

Analytics

PulseBoard.startSession(): void
PulseBoard.endSession(duration?: number): void
PulseBoard.trackScreen(screenName: string, loadTime?: number): void
PulseBoard.trackApiCall(
  endpoint:     string,
  httpMethod:   string,
  statusCode:   number,
  duration:     number,
  payloadSize?: number,
): void
PulseBoard.trackCrash(error: Error, isFatal?: boolean): void

Utilities

PulseBoard.getContext(): Promise<EnrichedContext>
PulseBoard.flush(): Promise<void>
PulseBoard.destroy(): void

Components & Hooks

// Error boundary — wraps your app to catch render errors
<PulseBoardErrorBoundary>
  <App />
</PulseBoardErrorBoundary>

// Hook — screen tracking and event helpers
const { trackScreen, track } = usePulseBoard()

Platform Support

| Platform | Minimum Version | | ------------ | --------------- | | iOS | 13.0+ | | Android | API 21+ | | React Native | 0.73+ |

Example App

See pulseboard-example-rn-cli for a full working example.

License

Private — © 2026 Aenexar. All rights reserved.