@aws-amplify/analytics/dist/esm/utils/trackerHelpers.d.ts

Analytics category of aws-amplify

import { TrackerEventRecorder, TrackerInterface, TrackerType } from '../types/trackers';
import { AnalyticsConfigureAutoTrackInput } from '../types/inputs';
/**
 * Updates a provider's trackers as appropriate for the provided auto-track configuration.
 *
 * @remark
 * This utility will mutate the provider's configured trackers via `providerTrackers`.
 *
 * @param namespace - Optional provider identifier used to namespace shared page-view
 *  tracking state (the `sessionStorage` key). Providers that can be enabled alongside
 *  another provider's `pageView` auto-track (e.g. Kinesis, Kinesis Firehose) must pass a
 *  unique value so each provider records page views independently instead of clobbering a
 *  shared key.
 */
export declare const updateProviderTrackers: (input: AnalyticsConfigureAutoTrackInput, providerEventRecorder: TrackerEventRecorder, providerTrackers: Partial<Record<TrackerType, TrackerInterface>>, namespace?: string) => void;