Skip to content

Commit

Permalink
Applying documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Sep 15, 2022
1 parent cf3f656 commit dc8fa2a
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## BrowserTracker.crossDomainLinker property

Enable querystring decoration for links pasing a filter
Enable querystring decoration for links passing a filter

<b>Signature:</b>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ interface BrowserTracker
| [addPlugin](./browser-tracker.browsertracker.addplugin.md) | (configuration: BrowserPluginConfiguration) =&gt; void | Add a plugin into the plugin collection after Tracker has already been initialised |
| [clearUserData](./browser-tracker.browsertracker.clearuserdata.md) | (configuration?: ClearUserDataConfiguration) =&gt; 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) =&gt; boolean) =&gt; void | Enable querystring decoration for links pasing a filter |
| [crossDomainLinker](./browser-tracker.browsertracker.crossdomainlinker.md) | (crossDomainLinkerCriterion: (elt: HTMLAnchorElement \| HTMLAreaElement) =&gt; boolean) =&gt; void | Enable querystring decoration for links passing a filter |
| [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. |
| [discardBrace](./browser-tracker.browsertracker.discardbrace.md) | (enableFilter: boolean) =&gt; void | Strip braces from URL |
| [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) | (enableFilter: boolean) =&gt; void | Strip hash tag (or anchor) from URL |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BuiltInContexts](./browser-tracker.builtincontexts.md)

## BuiltInContexts type

<b>Signature:</b>

```typescript
type BuiltInContexts = RequireAtLeastOne<{
/* Toggles the web_page context */
webPage: boolean;
/* Toggles the session context */
session: boolean;
}> | Record<string, never>;
```
1 change: 1 addition & 0 deletions trackers/browser-tracker/docs/markdown/browser-tracker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,7 @@ type TrackerConfiguration = {
resetActivityTrackingOnPageView?: boolean;
connectionTimeout?: number;
anonymousTracking?: AnonymousTrackingOptions;
contexts?: {
webPage: boolean;
session: boolean;
};
contexts?: BuiltInContexts;
plugins?: Array<BrowserPlugin>;
customHeaders?: Record<string, string>;
retryStatusCodes?: number[];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Create an emitter object, which uses the `got` library, that will send events to
<b>Signature:</b>

```typescript
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;
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;
```

## Parameters
Expand Down

0 comments on commit dc8fa2a

Please sign in to comment.