rollbar/src/browser/replay/recorder.d.ts

Effortlessly track and debug errors in your JavaScript applications with Rollbar. This package includes advanced error tracking features and an intuitive interface to help you identify and fix issues more quickly.

/** A point-in-time cursor into the active Recorder's two-slot ring buffer. */
export interface BufferCursor {
  /** Index (0|1) of the active buffer's slot at snapshot time. */
  slot: 0 | 1;
  /**
   * Zero-based index of the last event at snapshot time; exclusive boundary.
   * May be -1 when empty.
   */
  offset: number;
}

export default class Recorder {
  constructor(options: Record<string, any>);

  get isRecording(): boolean;
  get isReady(): boolean;
  get options(): Record<string, any>;
  set options(newOptions: Record<string, any>);

  configure(newOptions: Record<string, any>): void;
  checkoutEveryNms(): number;
  bufferCursor(): BufferCursor;
  exportRecordingSpan(
    tracing: any,
    attributes?: Record<string, any>,
    cursor?: BufferCursor,
  ): void;
  start(): this;
  stop(): this;
  clear(): void;

  // Internal only - for testing
  get _recordFn(): (event: any) => void;
}