Skip to content

Commit dc8fa2a

Browse files
Applying documentation updates.
1 parent cf3f656 commit dc8fa2a

6 files changed

+21
-7
lines changed

trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.crossdomainlinker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## BrowserTracker.crossDomainLinker property
66

7-
Enable querystring decoration for links pasing a filter
7+
Enable querystring decoration for links passing a filter
88

99
<b>Signature:</b>
1010

trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ interface BrowserTracker
1919
| [addPlugin](./browser-tracker.browsertracker.addplugin.md) | (configuration: BrowserPluginConfiguration) =&gt; void | Add a plugin into the plugin collection after Tracker has already been initialised |
2020
| [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) =&gt; void | Clears all cookies and local storage containing user and session identifiers |
2121
| [core](./browser-tracker.browsertracker.core.md) | TrackerCore | The instance of the core library which this tracker has initialised |
22-
| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) =&gt; boolean) =&gt; void | Enable querystring decoration for links pasing a filter |
22+
| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) =&gt; boolean) =&gt; void | Enable querystring decoration for links passing a filter |
2323
| [disableAnonymousTracking](./browser-tracker.browsertracker.disableanonymoustracking.md) | (configuration?: DisableAnonymousTrackingConfiguration) =&gt; void | Disables anonymous tracking if active (ie. tracker initialized with <code>anonymousTracking</code>) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. |
2424
| [discardBrace](./browser-tracker.browsertracker.discardbrace.md) | (enableFilter: boolean) =&gt; void | Strip braces from URL |
2525
| [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) =&gt; void | Strip hash tag (or anchor) from URL |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BuiltInContexts](./browser-tracker.builtincontexts.md)
4+
5+
## BuiltInContexts type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type BuiltInContexts = RequireAtLeastOne<{
11+
/* Toggles the web_page context */
12+
webPage: boolean;
13+
/* Toggles the session context */
14+
session: boolean;
15+
}> | Record<string, never>;
16+
```

trackers/browser-tracker/docs/markdown/browser-tracker.md

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@
7575
| [ActivityCallback](./browser-tracker.activitycallback.md) | The callback for enableActivityTrackingCallback |
7676
| [ActivityCallbackData](./browser-tracker.activitycallbackdata.md) | The data which is passed to the Activity Tracking callback |
7777
| [AnonymousTrackingOptions](./browser-tracker.anonymoustrackingoptions.md) | |
78+
| [BuiltInContexts](./browser-tracker.builtincontexts.md) | |
7879
| [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 |
7980
| [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 |
8081
| [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 |

trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,7 @@ type TrackerConfiguration = {
3434
resetActivityTrackingOnPageView?: boolean;
3535
connectionTimeout?: number;
3636
anonymousTracking?: AnonymousTrackingOptions;
37-
contexts?: {
38-
webPage: boolean;
39-
session: boolean;
40-
};
37+
contexts?: BuiltInContexts;
4138
plugins?: Array<BrowserPlugin>;
4239
customHeaders?: Record<string, string>;
4340
retryStatusCodes?: number[];

trackers/node-tracker/docs/markdown/node-tracker.gotemitter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Create an emitter object, which uses the `got` library, that will send events to
99
<b>Signature:</b>
1010

1111
```typescript
12-
declare function gotEmitter(endpoint: string, protocol: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial<RequiredRetryOptions>, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response<string>) => void, agents?: Agents): Emitter;
12+
declare function gotEmitter(endpoint: string, protocol?: HttpProtocol, port?: number, method?: HttpMethod, bufferSize?: number, retry?: number | Partial<RequiredRetryOptions>, cookieJar?: PromiseCookieJar | ToughCookieJar, callback?: (error?: RequestError, response?: Response<string>) => void, agents?: Agents): Emitter;
1313
```
1414

1515
## Parameters

0 commit comments

Comments
 (0)