From dc8fa2a1df02e74bbb1ee5c313c2b64907b152ea Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 15 Sep 2022 07:58:59 +0000 Subject: [PATCH] Applying documentation updates. --- ...r-tracker.browsertracker.crossdomainlinker.md | 2 +- .../markdown/browser-tracker.browsertracker.md | 2 +- .../markdown/browser-tracker.builtincontexts.md | 16 ++++++++++++++++ .../docs/markdown/browser-tracker.md | 1 + .../browser-tracker.trackerconfiguration.md | 5 +---- .../docs/markdown/node-tracker.gotemitter.md | 2 +- 6 files changed, 21 insertions(+), 7 deletions(-) create mode 100644 trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md index b139a323f..2789a65a9 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md @@ -4,7 +4,7 @@ ## BrowserTracker.crossDomainLinker property -Enable querystring decoration for links pasing a filter +Enable querystring decoration for links passing a filter Signature: diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md index 2de80b0d3..e57371ac2 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md @@ -19,7 +19,7 @@ interface BrowserTracker | [addPlugin](./browser-tracker.browsertracker.addplugin.md) | (configuration: BrowserPluginConfiguration) => void | Add a plugin into the plugin collection after Tracker has already been initialised | | [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) => void | Clears all cookies and local storage containing user and session identifiers | | [core](./browser-tracker.browsertracker.core.md) | TrackerCore | The instance of the core library which this tracker has initialised | -| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) => boolean) => void | Enable querystring decoration for links pasing a filter | +| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) => boolean) => void | Enable querystring decoration for links passing a filter | | [disableAnonymousTracking](./browser-tracker.browsertracker.disableanonymoustracking.md) | (configuration?: DisableAnonymousTrackingConfiguration) => void | Disables anonymous tracking if active (ie. tracker initialized with anonymousTracking) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. | | [discardBrace](./browser-tracker.browsertracker.discardbrace.md) | (enableFilter: boolean) => void | Strip braces from URL | | [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) => void | Strip hash tag (or anchor) from URL | diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md b/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md new file mode 100644 index 000000000..27640989a --- /dev/null +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BuiltInContexts](./browser-tracker.builtincontexts.md) + +## BuiltInContexts type + +Signature: + +```typescript +type BuiltInContexts = RequireAtLeastOne<{ + /* Toggles the web_page context */ + webPage: boolean; + /* Toggles the session context */ + session: boolean; +}> | Record; +``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.md index 69a8687bf..b72de0a61 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.md @@ -75,6 +75,7 @@ | [ActivityCallback](./browser-tracker.activitycallback.md) | The callback for enableActivityTrackingCallback | | [ActivityCallbackData](./browser-tracker.activitycallbackdata.md) | The data which is passed to the Activity Tracking callback | | [AnonymousTrackingOptions](./browser-tracker.anonymoustrackingoptions.md) | | +| [BuiltInContexts](./browser-tracker.builtincontexts.md) | | | [ConditionalContextProvider](./browser-tracker.conditionalcontextprovider.md) | Conditional context providers are two element arrays used to decide when to attach contexts, where: - the first element is some conditional criterion - the second element is any number of context primitives | | [ContextFilter](./browser-tracker.contextfilter.md) | A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event | | [ContextGenerator](./browser-tracker.contextgenerator.md) | A context generator is a user-supplied callback that is evaluated for each event to allow an additional context to be dynamically attached to the event | diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md index c9b080c81..a6a0b3385 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md @@ -34,10 +34,7 @@ type TrackerConfiguration = { resetActivityTrackingOnPageView?: boolean; connectionTimeout?: number; anonymousTracking?: AnonymousTrackingOptions; - contexts?: { - webPage: boolean; - session: boolean; - }; + contexts?: BuiltInContexts; plugins?: Array; customHeaders?: Record; retryStatusCodes?: number[]; diff --git a/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md b/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md index 66b15ee4a..36aa918c6 100644 --- a/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md +++ b/trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md @@ -9,7 +9,7 @@ Create an emitter object, which uses the `got` library, that will send events to Signature: ```typescript -declare function gotEmitter(endpoint: string, protocol: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response) => void, agents?: Agents): Emitter; +declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response) => void, agents?: Agents): Emitter; ``` ## Parameters