Skip to content

Commit 6f71c2d

Browse files
Applying documentation updates.
1 parent 9e00c56 commit 6f71c2d

5 files changed

+33
-2
lines changed

api-docs/docs/browser-tracker/markdown/browser-tracker.crossdomainlinker.md

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

55
## crossDomainLinker() function
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

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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; [ExtendedCrossDomainLinkerAttributes](./browser-tracker.extendedcrossdomainlinkerattributes.md)
4+
5+
## ExtendedCrossDomainLinkerAttributes type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type ExtendedCrossDomainLinkerAttributes = {
11+
userId?: boolean;
12+
sessionId?: boolean;
13+
sourceId?: boolean;
14+
sourcePlatform?: boolean;
15+
reason?: boolean | ((evt: Event) => string);
16+
};
17+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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; [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md)
4+
5+
## ExtendedCrossDomainLinkerOptions type
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type ExtendedCrossDomainLinkerOptions = boolean | ExtendedCrossDomainLinkerAttributes;
11+
```

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

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
| [addPlugin(configuration, trackers)](./browser-tracker.addplugin.md) | Add a plugin into the plugin collection after trackers have already been initialised |
1313
| [clearGlobalContexts(trackers)](./browser-tracker.clearglobalcontexts.md) | Clear all global contexts that are sent with events |
1414
| [clearUserData(configuration, trackers)](./browser-tracker.clearuserdata.md) | Clears all cookies and local storage containing user and session identifiers |
15-
| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links pasing a filter |
15+
| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links passing a filter |
1616
| [disableActivityTracking(trackers)](./browser-tracker.disableactivitytracking.md) | Disables page activity tracking. |
1717
| [disableActivityTrackingCallback(trackers)](./browser-tracker.disableactivitytrackingcallback.md) | Disables page activity tracking callback. |
1818
| [disableAnonymousTracking(configuration, trackers)](./browser-tracker.disableanonymoustracking.md) | 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. |
@@ -86,6 +86,8 @@
8686
| [CookieSameSite](./browser-tracker.cookiesamesite.md) | |
8787
| [EventBatch](./browser-tracker.eventbatch.md) | A collection of events which are sent to the collector. This can either be a collection of query strings or JSON objects. |
8888
| [EventMethod](./browser-tracker.eventmethod.md) | |
89+
| [ExtendedCrossDomainLinkerAttributes](./browser-tracker.extendedcrossdomainlinkerattributes.md) | |
90+
| [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md) | |
8991
| [FilterProvider](./browser-tracker.filterprovider.md) | A filter provider is a tuple that has two parts: a context filter and the context primitive(s) If the context filter evaluates to true, the tracker will attach the context primitive(s) |
9092
| [GetBatch](./browser-tracker.getbatch.md) | A collection of GET events which are sent to the collector. This will be a collection of query strings. |
9193
| [Platform](./browser-tracker.platform.md) | |

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

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ type TrackerConfiguration = {
2626
useStm?: boolean;
2727
bufferSize?: number;
2828
crossDomainLinker?: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean;
29+
useExtendedCrossDomainLinker?: ExtendedCrossDomainLinkerOptions;
2930
maxPostBytes?: number;
3031
maxGetBytes?: number;
3132
discoverRootDomain?: boolean;

0 commit comments

Comments
 (0)