@snowplow/browser-tracker
Advanced tools
@snowplow/browser-tracker - npm Package Compare versions
Comparing version 3.0.0-beta.5 to 3.0.0
| import { TrackerConfiguration, BrowserTracker, BrowserPlugin, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, BrowserPluginConfiguration, DisableAnonymousTrackingConfiguration, EnableAnonymousTrackingConfiguration, FlushBufferConfiguration, PageViewEvent } from '@snowplow/browser-tracker-core'; | ||
| import { CommonEventProperties, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, StructuredEvent } from "@snowplow/tracker-core"; | ||
| import { version, CommonEventProperties, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, StructuredEvent } from '@snowplow/tracker-core'; | ||
| /** | ||
| * Initialise a new tracker | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| */ | ||
@@ -13,5 +13,5 @@ declare function newTracker(trackerId: string, endpoint: string): BrowserTracker; | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param configuration The initialisation options of the tracker | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| * @param configuration - The initialisation options of the tracker | ||
| */ | ||
@@ -22,3 +22,3 @@ declare function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker; | ||
| * | ||
| * @param trackers The tracker identifiers which will have their session refreshed | ||
| * @param trackers - The tracker identifiers which will have their session refreshed | ||
| */ | ||
@@ -29,4 +29,4 @@ declare function newSession(trackers?: Array<string>): void; | ||
| * | ||
| * @param url Custom Referrer which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom Referrer which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -37,4 +37,4 @@ declare function setReferrerUrl(url: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param url Custom URL which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom URL which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -45,4 +45,4 @@ declare function setCustomUrl(url: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param title Document title which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param title - Document title which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -53,4 +53,4 @@ declare function setDocumentTitle(title: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param enable Whether to enable stripping of hash | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whether to enable stripping of hash | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -61,4 +61,4 @@ declare function discardHashTag(enable: boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param enable Whther to enable stripping of braces | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whther to enable stripping of braces | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -69,4 +69,4 @@ declare function discardBrace(enable: boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param domain | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param path - The path which will be used when setting cookies | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -77,4 +77,4 @@ declare function setCookiePath(path: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param timeout | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param timeout - The timeout until cookies will expire | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -85,4 +85,4 @@ declare function setVisitorCookieTimeout(timeout: number, trackers?: Array<string>): void; | ||
| * | ||
| * @param crossDomainLinker Function used to determine which links to decorate | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param crossDomainLinker - Function used to determine which links to decorate | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -93,4 +93,4 @@ declare function crossDomainLinker(crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The activity tracking configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -101,4 +101,4 @@ declare function enableActivityTracking(configuration: ActivityTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The activity tracking callback configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking callback configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -109,3 +109,3 @@ declare function enableActivityTrackingCallback(configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which will be updated | ||
| * @param trackers - The tracker identifiers which will be updated | ||
| */ | ||
@@ -116,4 +116,4 @@ declare function updatePageActivity(trackers?: Array<string>): void; | ||
| * | ||
| * @param name of the opt out cookie | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param name - of the opt out cookie | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -124,4 +124,4 @@ declare function setOptOutCookie(name: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param userId The business-defined user ID | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param userId - The business-defined user ID | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -132,4 +132,4 @@ declare function setUserId(userId: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -140,4 +140,4 @@ declare function setUserIdFromLocation(querystringField: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -148,4 +148,4 @@ declare function setUserIdFromReferrer(querystringField: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param cookieName Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param cookieName - Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -157,4 +157,4 @@ declare function setUserIdFromCookie(cookieName: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param collectorUrl The collector URL, with or without protocol | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param collectorUrl - The collector URL, with or without protocol | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -167,4 +167,4 @@ declare function setCollectorUrl(collectorUrl: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param newBufferSize The value with which to update the bufferSize to | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param newBufferSize - The value with which to update the bufferSize to | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -176,4 +176,4 @@ declare function setBufferSize(newBufferSize: number, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration to use following flushing the buffer | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param configuration - The configuration to use following flushing the buffer | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -184,4 +184,4 @@ declare function flushBuffer(configuration?: FlushBufferConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The Page View Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Page View Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -195,4 +195,4 @@ declare function trackPageView(event?: PageViewEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The Structured Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Structured Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -205,4 +205,4 @@ declare function trackStructEvent(event: StructuredEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The event information | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The event information | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -213,4 +213,4 @@ declare function trackSelfDescribingEvent(event: SelfDescribingEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be added to | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be added to | ||
| */ | ||
@@ -221,4 +221,4 @@ declare function addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive>, trackers?: Array<string>): void; | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be remove from | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be remove from | ||
| */ | ||
@@ -229,3 +229,3 @@ declare function removeGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive>, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the global contexts will be cleared from | ||
| * @param trackers - The tracker identifiers which the global contexts will be cleared from | ||
| */ | ||
@@ -236,3 +236,3 @@ declare function clearGlobalContexts(trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the event will preserve their Page View Ids | ||
| * @param trackers - The tracker identifiers which the event will preserve their Page View Ids | ||
| */ | ||
@@ -245,4 +245,4 @@ declare function preservePageViewId(trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration for disabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for disabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -253,4 +253,4 @@ declare function disableAnonymousTracking(configuration?: DisableAnonymousTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration for enabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for enabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -261,3 +261,3 @@ declare function enableAnonymousTracking(configuration?: EnableAnonymousTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -268,7 +268,6 @@ declare function clearUserData(trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The plugin to add | ||
| * @param trackers The tracker identifiers which the plugin will be added to | ||
| * @param configuration - The plugin to add | ||
| * @param trackers - The tracker identifiers which the plugin will be added to | ||
| */ | ||
| declare function addPlugin(configuration: BrowserPluginConfiguration, trackers?: Array<string>): void; | ||
| export { newTracker, BrowserTracker, TrackerConfiguration, BrowserPlugin, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, FlushBufferConfiguration, PageViewEvent, EnableAnonymousTrackingConfiguration, DisableAnonymousTrackingConfiguration, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, CommonEventProperties, StructuredEvent, newSession, setReferrerUrl, setCustomUrl, setDocumentTitle, discardHashTag, discardBrace, setCookiePath, setVisitorCookieTimeout, crossDomainLinker, enableActivityTracking, enableActivityTrackingCallback, updatePageActivity, setOptOutCookie, setUserId, setUserIdFromLocation, setUserIdFromReferrer, setUserIdFromCookie, setCollectorUrl, setBufferSize, flushBuffer, trackPageView, trackStructEvent, trackSelfDescribingEvent, addGlobalContexts, removeGlobalContexts, clearGlobalContexts, preservePageViewId, disableAnonymousTracking, enableAnonymousTracking, clearUserData, addPlugin }; | ||
| export { version } from '@snowplow/tracker-core'; | ||
| export { newTracker, BrowserTracker, TrackerConfiguration, BrowserPlugin, version, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, BrowserPluginConfiguration, FlushBufferConfiguration, PageViewEvent, EnableAnonymousTrackingConfiguration, DisableAnonymousTrackingConfiguration, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, CommonEventProperties, StructuredEvent, newSession, setReferrerUrl, setCustomUrl, setDocumentTitle, discardHashTag, discardBrace, setCookiePath, setVisitorCookieTimeout, crossDomainLinker, enableActivityTracking, enableActivityTrackingCallback, updatePageActivity, setOptOutCookie, setUserId, setUserIdFromLocation, setUserIdFromReferrer, setUserIdFromCookie, setCollectorUrl, setBufferSize, flushBuffer, trackPageView, trackStructEvent, trackSelfDescribingEvent, addGlobalContexts, removeGlobalContexts, clearGlobalContexts, preservePageViewId, disableAnonymousTracking, enableAnonymousTracking, clearUserData, addPlugin }; |
| /*! | ||
| * Browser tracker for Snowplow v3.0.0-beta.5 (http://bit.ly/sp-js) | ||
| * Browser tracker for Snowplow v3.0.0 (http://bit.ly/sp-js) | ||
| * Copyright 2021 Snowplow Analytics Ltd, 2010 Anthon Pang | ||
@@ -43,3 +43,3 @@ * Licensed under BSD-3-Clause | ||
| * | ||
| * @param trackers The tracker identifiers which will have their session refreshed | ||
| * @param trackers - The tracker identifiers which will have their session refreshed | ||
| */ | ||
@@ -54,4 +54,4 @@ function newSession(trackers) { | ||
| * | ||
| * @param url Custom Referrer which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom Referrer which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -66,4 +66,4 @@ function setReferrerUrl(url, trackers) { | ||
| * | ||
| * @param url Custom URL which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom URL which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -78,4 +78,4 @@ function setCustomUrl(url, trackers) { | ||
| * | ||
| * @param title Document title which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param title - Document title which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -90,4 +90,4 @@ function setDocumentTitle(title, trackers) { | ||
| * | ||
| * @param enable Whether to enable stripping of hash | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whether to enable stripping of hash | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -102,4 +102,4 @@ function discardHashTag(enable, trackers) { | ||
| * | ||
| * @param enable Whther to enable stripping of braces | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whther to enable stripping of braces | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -114,4 +114,4 @@ function discardBrace(enable, trackers) { | ||
| * | ||
| * @param domain | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param path - The path which will be used when setting cookies | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -126,4 +126,4 @@ function setCookiePath(path, trackers) { | ||
| * | ||
| * @param timeout | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param timeout - The timeout until cookies will expire | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -138,4 +138,4 @@ function setVisitorCookieTimeout(timeout, trackers) { | ||
| * | ||
| * @param crossDomainLinker Function used to determine which links to decorate | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param crossDomainLinker - Function used to determine which links to decorate | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -150,4 +150,4 @@ function crossDomainLinker(crossDomainLinkerCriterion, trackers) { | ||
| * | ||
| * @param configuration The activity tracking configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -162,4 +162,4 @@ function enableActivityTracking(configuration, trackers) { | ||
| * | ||
| * @param configuration The activity tracking callback configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking callback configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -174,3 +174,3 @@ function enableActivityTrackingCallback(configuration, trackers) { | ||
| * | ||
| * @param trackers The tracker identifiers which will be updated | ||
| * @param trackers - The tracker identifiers which will be updated | ||
| */ | ||
@@ -185,4 +185,4 @@ function updatePageActivity(trackers) { | ||
| * | ||
| * @param name of the opt out cookie | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param name - of the opt out cookie | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -197,4 +197,4 @@ function setOptOutCookie(name, trackers) { | ||
| * | ||
| * @param userId The business-defined user ID | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param userId - The business-defined user ID | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -209,4 +209,4 @@ function setUserId(userId, trackers) { | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -221,4 +221,4 @@ function setUserIdFromLocation(querystringField, trackers) { | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -233,4 +233,4 @@ function setUserIdFromReferrer(querystringField, trackers) { | ||
| * | ||
| * @param cookieName Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param cookieName - Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -246,4 +246,4 @@ function setUserIdFromCookie(cookieName, trackers) { | ||
| * | ||
| * @param collectorUrl The collector URL, with or without protocol | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param collectorUrl - The collector URL, with or without protocol | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -260,4 +260,4 @@ function setCollectorUrl(collectorUrl, trackers) { | ||
| * | ||
| * @param newBufferSize The value with which to update the bufferSize to | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param newBufferSize - The value with which to update the bufferSize to | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -273,4 +273,4 @@ function setBufferSize(newBufferSize, trackers) { | ||
| * | ||
| * @param configuration The configuration to use following flushing the buffer | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param configuration - The configuration to use following flushing the buffer | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -285,4 +285,4 @@ function flushBuffer(configuration, trackers) { | ||
| * | ||
| * @param event The Page View Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Page View Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -300,4 +300,4 @@ function trackPageView(event, trackers) { | ||
| * | ||
| * @param event The Structured Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Structured Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -314,4 +314,4 @@ function trackStructEvent(event, trackers) { | ||
| * | ||
| * @param event The event information | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The event information | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -326,4 +326,4 @@ function trackSelfDescribingEvent(event, trackers) { | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be added to | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be added to | ||
| */ | ||
@@ -338,4 +338,4 @@ function addGlobalContexts(contexts, trackers) { | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be remove from | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be remove from | ||
| */ | ||
@@ -350,3 +350,3 @@ function removeGlobalContexts(contexts, trackers) { | ||
| * | ||
| * @param trackers The tracker identifiers which the global contexts will be cleared from | ||
| * @param trackers - The tracker identifiers which the global contexts will be cleared from | ||
| */ | ||
@@ -361,3 +361,3 @@ function clearGlobalContexts(trackers) { | ||
| * | ||
| * @param trackers The tracker identifiers which the event will preserve their Page View Ids | ||
| * @param trackers - The tracker identifiers which the event will preserve their Page View Ids | ||
| */ | ||
@@ -374,4 +374,4 @@ function preservePageViewId(trackers) { | ||
| * | ||
| * @param configuration The configuration for disabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for disabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -386,4 +386,4 @@ function disableAnonymousTracking(configuration, trackers) { | ||
| * | ||
| * @param configuration The configuration for enabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for enabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -398,3 +398,3 @@ function enableAnonymousTracking(configuration, trackers) { | ||
| * | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -409,4 +409,4 @@ function clearUserData(trackers) { | ||
| * | ||
| * @param configuration The plugin to add | ||
| * @param trackers The tracker identifiers which the plugin will be added to | ||
| * @param configuration - The plugin to add | ||
| * @param trackers - The tracker identifiers which the plugin will be added to | ||
| */ | ||
@@ -452,5 +452,5 @@ function addPlugin(configuration, trackers) { | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param configuration The initialisation options of the tracker | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| * @param configuration - The initialisation options of the tracker | ||
| */ | ||
@@ -457,0 +457,0 @@ function newTracker(trackerId, endpoint, configuration) { |
| import { TrackerConfiguration, BrowserTracker, BrowserPlugin, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, BrowserPluginConfiguration, DisableAnonymousTrackingConfiguration, EnableAnonymousTrackingConfiguration, FlushBufferConfiguration, PageViewEvent } from '@snowplow/browser-tracker-core'; | ||
| import { CommonEventProperties, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, StructuredEvent } from "@snowplow/tracker-core"; | ||
| import { version, CommonEventProperties, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, StructuredEvent } from '@snowplow/tracker-core'; | ||
| /** | ||
| * Initialise a new tracker | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| */ | ||
@@ -13,5 +13,5 @@ declare function newTracker(trackerId: string, endpoint: string): BrowserTracker; | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param configuration The initialisation options of the tracker | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| * @param configuration - The initialisation options of the tracker | ||
| */ | ||
@@ -22,3 +22,3 @@ declare function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker; | ||
| * | ||
| * @param trackers The tracker identifiers which will have their session refreshed | ||
| * @param trackers - The tracker identifiers which will have their session refreshed | ||
| */ | ||
@@ -29,4 +29,4 @@ declare function newSession(trackers?: Array<string>): void; | ||
| * | ||
| * @param url Custom Referrer which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom Referrer which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -37,4 +37,4 @@ declare function setReferrerUrl(url: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param url Custom URL which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom URL which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -45,4 +45,4 @@ declare function setCustomUrl(url: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param title Document title which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param title - Document title which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -53,4 +53,4 @@ declare function setDocumentTitle(title: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param enable Whether to enable stripping of hash | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whether to enable stripping of hash | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -61,4 +61,4 @@ declare function discardHashTag(enable: boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param enable Whther to enable stripping of braces | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whther to enable stripping of braces | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -69,4 +69,4 @@ declare function discardBrace(enable: boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param domain | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param path - The path which will be used when setting cookies | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -77,4 +77,4 @@ declare function setCookiePath(path: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param timeout | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param timeout - The timeout until cookies will expire | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -85,4 +85,4 @@ declare function setVisitorCookieTimeout(timeout: number, trackers?: Array<string>): void; | ||
| * | ||
| * @param crossDomainLinker Function used to determine which links to decorate | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param crossDomainLinker - Function used to determine which links to decorate | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -93,4 +93,4 @@ declare function crossDomainLinker(crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The activity tracking configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -101,4 +101,4 @@ declare function enableActivityTracking(configuration: ActivityTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The activity tracking callback configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking callback configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -109,3 +109,3 @@ declare function enableActivityTrackingCallback(configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which will be updated | ||
| * @param trackers - The tracker identifiers which will be updated | ||
| */ | ||
@@ -116,4 +116,4 @@ declare function updatePageActivity(trackers?: Array<string>): void; | ||
| * | ||
| * @param name of the opt out cookie | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param name - of the opt out cookie | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -124,4 +124,4 @@ declare function setOptOutCookie(name: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param userId The business-defined user ID | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param userId - The business-defined user ID | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -132,4 +132,4 @@ declare function setUserId(userId: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -140,4 +140,4 @@ declare function setUserIdFromLocation(querystringField: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -148,4 +148,4 @@ declare function setUserIdFromReferrer(querystringField: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param cookieName Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param cookieName - Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -157,4 +157,4 @@ declare function setUserIdFromCookie(cookieName: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param collectorUrl The collector URL, with or without protocol | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param collectorUrl - The collector URL, with or without protocol | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -167,4 +167,4 @@ declare function setCollectorUrl(collectorUrl: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param newBufferSize The value with which to update the bufferSize to | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param newBufferSize - The value with which to update the bufferSize to | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -176,4 +176,4 @@ declare function setBufferSize(newBufferSize: number, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration to use following flushing the buffer | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param configuration - The configuration to use following flushing the buffer | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -184,4 +184,4 @@ declare function flushBuffer(configuration?: FlushBufferConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The Page View Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Page View Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -195,4 +195,4 @@ declare function trackPageView(event?: PageViewEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The Structured Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Structured Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -205,4 +205,4 @@ declare function trackStructEvent(event: StructuredEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The event information | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The event information | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -213,4 +213,4 @@ declare function trackSelfDescribingEvent(event: SelfDescribingEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be added to | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be added to | ||
| */ | ||
@@ -221,4 +221,4 @@ declare function addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive>, trackers?: Array<string>): void; | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be remove from | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be remove from | ||
| */ | ||
@@ -229,3 +229,3 @@ declare function removeGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive>, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the global contexts will be cleared from | ||
| * @param trackers - The tracker identifiers which the global contexts will be cleared from | ||
| */ | ||
@@ -236,3 +236,3 @@ declare function clearGlobalContexts(trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the event will preserve their Page View Ids | ||
| * @param trackers - The tracker identifiers which the event will preserve their Page View Ids | ||
| */ | ||
@@ -245,4 +245,4 @@ declare function preservePageViewId(trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration for disabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for disabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -253,4 +253,4 @@ declare function disableAnonymousTracking(configuration?: DisableAnonymousTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration for enabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for enabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -261,3 +261,3 @@ declare function enableAnonymousTracking(configuration?: EnableAnonymousTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -268,7 +268,6 @@ declare function clearUserData(trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The plugin to add | ||
| * @param trackers The tracker identifiers which the plugin will be added to | ||
| * @param configuration - The plugin to add | ||
| * @param trackers - The tracker identifiers which the plugin will be added to | ||
| */ | ||
| declare function addPlugin(configuration: BrowserPluginConfiguration, trackers?: Array<string>): void; | ||
| export { newTracker, BrowserTracker, TrackerConfiguration, BrowserPlugin, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, FlushBufferConfiguration, PageViewEvent, EnableAnonymousTrackingConfiguration, DisableAnonymousTrackingConfiguration, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, CommonEventProperties, StructuredEvent, newSession, setReferrerUrl, setCustomUrl, setDocumentTitle, discardHashTag, discardBrace, setCookiePath, setVisitorCookieTimeout, crossDomainLinker, enableActivityTracking, enableActivityTrackingCallback, updatePageActivity, setOptOutCookie, setUserId, setUserIdFromLocation, setUserIdFromReferrer, setUserIdFromCookie, setCollectorUrl, setBufferSize, flushBuffer, trackPageView, trackStructEvent, trackSelfDescribingEvent, addGlobalContexts, removeGlobalContexts, clearGlobalContexts, preservePageViewId, disableAnonymousTracking, enableAnonymousTracking, clearUserData, addPlugin }; | ||
| export { version } from '@snowplow/tracker-core'; | ||
| export { newTracker, BrowserTracker, TrackerConfiguration, BrowserPlugin, version, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, BrowserPluginConfiguration, FlushBufferConfiguration, PageViewEvent, EnableAnonymousTrackingConfiguration, DisableAnonymousTrackingConfiguration, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, CommonEventProperties, StructuredEvent, newSession, setReferrerUrl, setCustomUrl, setDocumentTitle, discardHashTag, discardBrace, setCookiePath, setVisitorCookieTimeout, crossDomainLinker, enableActivityTracking, enableActivityTrackingCallback, updatePageActivity, setOptOutCookie, setUserId, setUserIdFromLocation, setUserIdFromReferrer, setUserIdFromCookie, setCollectorUrl, setBufferSize, flushBuffer, trackPageView, trackStructEvent, trackSelfDescribingEvent, addGlobalContexts, removeGlobalContexts, clearGlobalContexts, preservePageViewId, disableAnonymousTracking, enableAnonymousTracking, clearUserData, addPlugin }; |
| import { TrackerConfiguration, BrowserTracker, BrowserPlugin, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, BrowserPluginConfiguration, DisableAnonymousTrackingConfiguration, EnableAnonymousTrackingConfiguration, FlushBufferConfiguration, PageViewEvent } from '@snowplow/browser-tracker-core'; | ||
| import { CommonEventProperties, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, StructuredEvent } from "@snowplow/tracker-core"; | ||
| import { version, CommonEventProperties, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, StructuredEvent } from '@snowplow/tracker-core'; | ||
| /** | ||
| * Initialise a new tracker | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| */ | ||
@@ -13,5 +13,5 @@ declare function newTracker(trackerId: string, endpoint: string): BrowserTracker; | ||
| * | ||
| * @param trackerId The tracker id - also known as tracker namespace | ||
| * @param endpoint Collector endpoint in the form collector.mysite.com | ||
| * @param configuration The initialisation options of the tracker | ||
| * @param trackerId - The tracker id - also known as tracker namespace | ||
| * @param endpoint - Collector endpoint in the form collector.mysite.com | ||
| * @param configuration - The initialisation options of the tracker | ||
| */ | ||
@@ -22,3 +22,3 @@ declare function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker; | ||
| * | ||
| * @param trackers The tracker identifiers which will have their session refreshed | ||
| * @param trackers - The tracker identifiers which will have their session refreshed | ||
| */ | ||
@@ -29,4 +29,4 @@ declare function newSession(trackers?: Array<string>): void; | ||
| * | ||
| * @param url Custom Referrer which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom Referrer which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -37,4 +37,4 @@ declare function setReferrerUrl(url: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param url Custom URL which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param url - Custom URL which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -45,4 +45,4 @@ declare function setCustomUrl(url: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param title Document title which will be used as override | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param title - Document title which will be used as override | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -53,4 +53,4 @@ declare function setDocumentTitle(title: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param enable Whether to enable stripping of hash | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whether to enable stripping of hash | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -61,4 +61,4 @@ declare function discardHashTag(enable: boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param enable Whther to enable stripping of braces | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param enable - Whther to enable stripping of braces | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -69,4 +69,4 @@ declare function discardBrace(enable: boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param domain | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param path - The path which will be used when setting cookies | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -77,4 +77,4 @@ declare function setCookiePath(path: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param timeout | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param timeout - The timeout until cookies will expire | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -85,4 +85,4 @@ declare function setVisitorCookieTimeout(timeout: number, trackers?: Array<string>): void; | ||
| * | ||
| * @param crossDomainLinker Function used to determine which links to decorate | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param crossDomainLinker - Function used to determine which links to decorate | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -93,4 +93,4 @@ declare function crossDomainLinker(crossDomainLinkerCriterion: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The activity tracking configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -101,4 +101,4 @@ declare function enableActivityTracking(configuration: ActivityTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The activity tracking callback configuration | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param configuration - The activity tracking callback configuration | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -109,3 +109,3 @@ declare function enableActivityTrackingCallback(configuration: ActivityTrackingConfiguration & ActivityTrackingConfigurationCallback, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which will be updated | ||
| * @param trackers - The tracker identifiers which will be updated | ||
| */ | ||
@@ -116,4 +116,4 @@ declare function updatePageActivity(trackers?: Array<string>): void; | ||
| * | ||
| * @param name of the opt out cookie | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param name - of the opt out cookie | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -124,4 +124,4 @@ declare function setOptOutCookie(name: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param userId The business-defined user ID | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param userId - The business-defined user ID | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -132,4 +132,4 @@ declare function setUserId(userId: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -140,4 +140,4 @@ declare function setUserIdFromLocation(querystringField: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param querystringField Name of a querystring name-value pair | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param querystringField - Name of a querystring name-value pair | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -148,4 +148,4 @@ declare function setUserIdFromReferrer(querystringField: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param cookieName Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param cookieName - Name of the cookie whose value will be assigned to businessUserId | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -157,4 +157,4 @@ declare function setUserIdFromCookie(cookieName: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param collectorUrl The collector URL, with or without protocol | ||
| * @param trackers The tracker identifiers which will be configured | ||
| * @param collectorUrl - The collector URL, with or without protocol | ||
| * @param trackers - The tracker identifiers which will be configured | ||
| */ | ||
@@ -167,4 +167,4 @@ declare function setCollectorUrl(collectorUrl: string, trackers?: Array<string>): void; | ||
| * | ||
| * @param newBufferSize The value with which to update the bufferSize to | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param newBufferSize - The value with which to update the bufferSize to | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -176,4 +176,4 @@ declare function setBufferSize(newBufferSize: number, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration to use following flushing the buffer | ||
| * @param trackers The tracker identifiers which will be flushed | ||
| * @param configuration - The configuration to use following flushing the buffer | ||
| * @param trackers - The tracker identifiers which will be flushed | ||
| */ | ||
@@ -184,4 +184,4 @@ declare function flushBuffer(configuration?: FlushBufferConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The Page View Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Page View Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -195,4 +195,4 @@ declare function trackPageView(event?: PageViewEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The Structured Event properties | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The Structured Event properties | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -205,4 +205,4 @@ declare function trackStructEvent(event: StructuredEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param event The event information | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param event - The event information | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -213,4 +213,4 @@ declare function trackSelfDescribingEvent(event: SelfDescribingEvent & CommonEventProperties, trackers?: Array<string>): void; | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be added to | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be added to | ||
| */ | ||
@@ -221,4 +221,4 @@ declare function addGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive>, trackers?: Array<string>): void; | ||
| * | ||
| * @param contexts An array of contexts or conditional contexts | ||
| * @param trackers The tracker identifiers which the global contexts will be remove from | ||
| * @param contexts - An array of contexts or conditional contexts | ||
| * @param trackers - The tracker identifiers which the global contexts will be remove from | ||
| */ | ||
@@ -229,3 +229,3 @@ declare function removeGlobalContexts(contexts: Array<ConditionalContextProvider | ContextPrimitive>, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the global contexts will be cleared from | ||
| * @param trackers - The tracker identifiers which the global contexts will be cleared from | ||
| */ | ||
@@ -236,3 +236,3 @@ declare function clearGlobalContexts(trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the event will preserve their Page View Ids | ||
| * @param trackers - The tracker identifiers which the event will preserve their Page View Ids | ||
| */ | ||
@@ -245,4 +245,4 @@ declare function preservePageViewId(trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration for disabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for disabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -253,4 +253,4 @@ declare function disableAnonymousTracking(configuration?: DisableAnonymousTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The configuration for enabling anonymous tracking | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param configuration - The configuration for enabling anonymous tracking | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -261,3 +261,3 @@ declare function enableAnonymousTracking(configuration?: EnableAnonymousTrackingConfiguration, trackers?: Array<string>): void; | ||
| * | ||
| * @param trackers The tracker identifiers which the event will be sent to | ||
| * @param trackers - The tracker identifiers which the event will be sent to | ||
| */ | ||
@@ -268,7 +268,6 @@ declare function clearUserData(trackers?: Array<string>): void; | ||
| * | ||
| * @param configuration The plugin to add | ||
| * @param trackers The tracker identifiers which the plugin will be added to | ||
| * @param configuration - The plugin to add | ||
| * @param trackers - The tracker identifiers which the plugin will be added to | ||
| */ | ||
| declare function addPlugin(configuration: BrowserPluginConfiguration, trackers?: Array<string>): void; | ||
| export { newTracker, BrowserTracker, TrackerConfiguration, BrowserPlugin, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, FlushBufferConfiguration, PageViewEvent, EnableAnonymousTrackingConfiguration, DisableAnonymousTrackingConfiguration, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, CommonEventProperties, StructuredEvent, newSession, setReferrerUrl, setCustomUrl, setDocumentTitle, discardHashTag, discardBrace, setCookiePath, setVisitorCookieTimeout, crossDomainLinker, enableActivityTracking, enableActivityTrackingCallback, updatePageActivity, setOptOutCookie, setUserId, setUserIdFromLocation, setUserIdFromReferrer, setUserIdFromCookie, setCollectorUrl, setBufferSize, flushBuffer, trackPageView, trackStructEvent, trackSelfDescribingEvent, addGlobalContexts, removeGlobalContexts, clearGlobalContexts, preservePageViewId, disableAnonymousTracking, enableAnonymousTracking, clearUserData, addPlugin }; | ||
| export { version } from '@snowplow/tracker-core'; | ||
| export { newTracker, BrowserTracker, TrackerConfiguration, BrowserPlugin, version, ActivityTrackingConfiguration, ActivityTrackingConfigurationCallback, BrowserPluginConfiguration, FlushBufferConfiguration, PageViewEvent, EnableAnonymousTrackingConfiguration, DisableAnonymousTrackingConfiguration, ConditionalContextProvider, ContextPrimitive, SelfDescribingEvent, SelfDescribingJson, CommonEventProperties, StructuredEvent, newSession, setReferrerUrl, setCustomUrl, setDocumentTitle, discardHashTag, discardBrace, setCookiePath, setVisitorCookieTimeout, crossDomainLinker, enableActivityTracking, enableActivityTrackingCallback, updatePageActivity, setOptOutCookie, setUserId, setUserIdFromLocation, setUserIdFromReferrer, setUserIdFromCookie, setCollectorUrl, setBufferSize, flushBuffer, trackPageView, trackStructEvent, trackSelfDescribingEvent, addGlobalContexts, removeGlobalContexts, clearGlobalContexts, preservePageViewId, disableAnonymousTracking, enableAnonymousTracking, clearUserData, addPlugin }; |
| /*! | ||
| * Browser tracker for Snowplow v3.0.0-beta.5 (http://bit.ly/sp-js) | ||
| * Browser tracker for Snowplow v3.0.0 (http://bit.ly/sp-js) | ||
| * Copyright 2021 Snowplow Analytics Ltd, 2010 Anthon Pang | ||
@@ -74,6 +74,6 @@ * Licensed under BSD-3-Clause | ||
| g.clearUserData=function(a){l(a,function(a){a.clearUserData()})};g.crossDomainLinker=function(a,b){l(b,function(b){b.crossDomainLinker(a)})};g.disableAnonymousTracking=function(a,b){l(b,function(b){b.disableAnonymousTracking(a)})};g.discardBrace=function(a,b){l(b,function(b){b.discardBrace(a)})};g.discardHashTag=function(a,b){l(b,function(b){b.discardHashTag(a)})};g.enableActivityTracking=function(a,b){l(b,function(b){b.enableActivityTracking(a)})};g.enableActivityTrackingCallback=function(a,b){l(b, | ||
| function(b){b.enableActivityTrackingCallback(a)})};g.enableAnonymousTracking=function(a,b){l(b,function(b){b.enableAnonymousTracking(a)})};g.flushBuffer=function(a,b){l(b,function(b){b.flushBuffer(a)})};g.newSession=function(a){l(a,function(a){a.newSession()})};g.newTracker=function(a,b,c){void 0===c&&(c={});if(Ca)return Y.hasOwnProperty(a)?a=null:(Y[a]=Pb(a,a,"js-3.0.0-beta.5",b,Ca,c),a=Y[a]),a};g.preservePageViewId=function(a){l(a,function(a){a.preservePageViewId()})};g.removeGlobalContexts=function(a, | ||
| function(b){b.enableActivityTrackingCallback(a)})};g.enableAnonymousTracking=function(a,b){l(b,function(b){b.enableAnonymousTracking(a)})};g.flushBuffer=function(a,b){l(b,function(b){b.flushBuffer(a)})};g.newSession=function(a){l(a,function(a){a.newSession()})};g.newTracker=function(a,b,c){void 0===c&&(c={});if(Ca)return Y.hasOwnProperty(a)?a=null:(Y[a]=Pb(a,a,"js-3.0.0",b,Ca,c),a=Y[a]),a};g.preservePageViewId=function(a){l(a,function(a){a.preservePageViewId()})};g.removeGlobalContexts=function(a, | ||
| b){l(b,function(b){b.core.removeGlobalContexts(a)})};g.setBufferSize=function(a,b){l(b,function(b){b.setBufferSize(a)})};g.setCollectorUrl=function(a,b){l(b,function(b){b.setCollectorUrl(a)})};g.setCookiePath=function(a,b){l(b,function(b){b.setCookiePath(a)})};g.setCustomUrl=function(a,b){l(b,function(b){b.setCustomUrl(a)})};g.setDocumentTitle=function(a,b){l(b,function(b){b.setDocumentTitle(a)})};g.setOptOutCookie=function(a,b){l(b,function(b){b.setOptOutCookie(a)})};g.setReferrerUrl=function(a, | ||
| b){l(b,function(b){b.setReferrerUrl(a)})};g.setUserId=function(a,b){l(b,function(b){b.setUserId(a)})};g.setUserIdFromCookie=function(a,b){l(b,function(b){b.setUserIdFromCookie(a)})};g.setUserIdFromLocation=function(a,b){l(b,function(b){b.setUserIdFromLocation(a)})};g.setUserIdFromReferrer=function(a,b){l(b,function(b){b.setUserIdFromReferrer(a)})};g.setVisitorCookieTimeout=function(a,b){l(b,function(b){b.setVisitorCookieTimeout(a)})};g.trackPageView=function(a,b){l(b,function(b){b.trackPageView(a)})}; | ||
| g.trackSelfDescribingEvent=function(a,b){l(b,function(b){b.core.track(Gb({event:a.event}),a.context,a.timestamp)})};g.trackStructEvent=function(a,b){l(b,function(b){b.core.track(Jb(a),a.context,a.timestamp)})};g.updatePageActivity=function(a){l(a,function(a){a.updatePageActivity()})};g.version="3.0.0-beta.5";Object.defineProperty(g,"__esModule",{value:!0})}) | ||
| g.trackSelfDescribingEvent=function(a,b){l(b,function(b){b.core.track(Gb({event:a.event}),a.context,a.timestamp)})};g.trackStructEvent=function(a,b){l(b,function(b){b.core.track(Jb(a),a.context,a.timestamp)})};g.updatePageActivity=function(a){l(a,function(a){a.updatePageActivity()})};g.version="3.0.0";Object.defineProperty(g,"__esModule",{value:!0})}) | ||
| //# sourceMappingURL=index.umd.min.js.map |
| { | ||
| "name": "@snowplow/browser-tracker", | ||
| "version": "3.0.0-beta.5", | ||
| "version": "3.0.0", | ||
| "description": "Browser tracker for Snowplow", | ||
@@ -38,4 +38,4 @@ "keywords": [ | ||
| "dependencies": { | ||
| "@snowplow/browser-tracker-core": "3.0.0-beta.5", | ||
| "@snowplow/tracker-core": "3.0.0-beta.5", | ||
| "@snowplow/browser-tracker-core": "3.0.0", | ||
| "@snowplow/tracker-core": "3.0.0", | ||
| "tslib": "^2.1.0" | ||
@@ -42,0 +42,0 @@ }, |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.29%
924229
- Number of package files
- increased by16.67%
14
- Lines of code
- increased by2.12%
5450
- Number of low quality alerts
- decreased by-100%
0
Dependency changes
+ Added@snowplow/browser-tracker-core@3.0.0(transitive)
+ Added@snowplow/tracker-core@3.0.0(transitive)
- Removed@snowplow/browser-tracker-core@3.0.0-beta.5(transitive)
- Removed@snowplow/tracker-core@3.0.0-beta.5(transitive)
Updated@snowplow/tracker-core@3.0.0