datadog-ux-utils/dist/telemetry/offlineQueue.persistent.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 { PersistentQueueOptions } from '../types/types.ts';

/**
 * Installs the persistent offline telemetry queue.
 *
 * Buffers telemetry events (actions/errors) while offline, persists to localStorage, and flushes when connectivity returns.
 * Safe to call multiple times. Returns an uninstall function.
 *
 * @param opts - Persistent queue configuration (see {@link PersistentQueueOptions}).
 * @returns Uninstall function to remove listeners and hooks.
 *
 * @example
 * ```ts
 * import { installPersistentTelemetryQueue } from "datadog-ux-utils/telemetry";
 *
 * installPersistentTelemetryQueue({
 *   maxBuffered: 600,
 *   storageKey: "dd_offline_queue_v1",
 *   byteCap: 2_000_000,
 *   flushOnInit: true,
 *   writeDebounceMs: 120,
 * });
 * ```
 */
export declare function installPersistentTelemetryQueue(opts?: PersistentQueueOptions): typeof uninstall;
/**
 * Uninstalls the persistent telemetry queue and removes listeners/hooks. Leaves stored events intact in localStorage.
 *
 * @returns void
 */
declare function uninstall(): void;
export {};
/** Example
import { installPersistentTelemetryQueue } from "@milliman/dd-ux-utils/telemetry/offlineQueue.persistent";

installPersistentTelemetryQueue({
  maxBuffered: 600,
  storageKey: "dd_offline_queue_v1",
  byteCap: 2_000_000,
  flushOnInit: true,
  writeDebounceMs: 120,
});
*/
//# sourceMappingURL=offlineQueue.persistent.d.ts.map