datadog-ux-utils/dist/errors/consoleCapture.d.ts

Datadog RUM focused UX & performance toolkit: API guards (retry, breaker, rate), React telemetry (error boundary, profiler, Suspense), web vitals & resource observers, offline queues.

import { ConsoleCaptureOptions } from '../types/types.ts';

/**
 * Installs console capture to report errors, warnings, and logs to telemetry.
 *
 * Call once at app startup after `initDatadog()`. Returns an uninstall function that restores the original console methods.
 *
 * @param options - Console capture configuration (see {@link ConsoleCaptureOptions}).
 * @returns Uninstall function to restore original console methods.
 *
 * @example
 * ```ts
 * import { captureConsole } from "datadog-ux-utils/errors";
 *
 * captureConsole({
 *   errorRate: 25,
 *   warnRate: 10,
 *   logRate: 0,          // keep 0 to disable log capture
 *   includeTrace: true,  // attach a short stack to warns/logs
 *   captureInDev: false, // keep dev noise low
 * });
 * ```
 */
export declare function captureConsole(options?: ConsoleCaptureOptions): typeof uninstall;
/**
 * Restores original console methods and clears dedupe memory.
 *
 * @returns void
 *
 * @example
 * ```ts
 * const undo = captureConsole();
 * // ...later
 * undo(); // restores console methods
 * ```
 */
export declare function uninstall(): void;
/**
 * Example
import { captureConsole } from "@milliman/dd-ux-utils/errors/consoleCapture";

captureConsole({
  errorRate: 25,
  warnRate: 10,
  logRate: 0,          // keep 0 to disable log capture
  includeTrace: true,  // attach a short stack to warns/logs
  captureInDev: false, // keep dev noise low
});
 */
//# sourceMappingURL=consoleCapture.d.ts.map