Applying documentation updates.

snowplow · Mar 30, 2023 · d170327 · d170327
1 parent cebce74
commit d170327
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/...s/browser-tracker/docs/markdown/browser-tracker.browsertracker.getpageviewid.md b/...s/browser-tracker/docs/markdown/browser-tracker.browsertracker.getpageviewid.md
@@ -9,5 +9,5 @@ Get the current page view ID
 <b>Signature:</b>
 
 ```typescript
-getPageViewId: () => void;
+getPageViewId: () => string;
 ```
diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.gettabid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.gettabid.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [BrowserTracker](./browser-tracker.browsertracker.md) &gt; [getTabId](./browser-tracker.browsertracker.gettabid.md)
+
+## BrowserTracker.getTabId property
+
+Get the current browser tab ID
+
+<b>Signature:</b>
+
+```typescript
+getTabId: () => string | null;
+```
diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md
@@ -31,7 +31,8 @@ interface BrowserTracker
 |  [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () =&gt; void | Get the domain session index also known as current memorized visit count. |
 |  [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () =&gt; void | Get visitor ID (from first party cookie) |
 |  [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () =&gt; void | Get the visitor information (from first party cookie) |
-|  [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () =&gt; void | Get the current page view ID |
+|  [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () =&gt; string | Get the current page view ID |
+|  [getTabId](./browser-tracker.browsertracker.gettabid.md) | () =&gt; string \| null | Get the current browser tab ID |
 |  [getUserId](./browser-tracker.browsertracker.getuserid.md) | () =&gt; void | Get the current user ID (as set previously with setUserId()). |
 |  [id](./browser-tracker.browsertracker.id.md) | string | The unique identifier of this tracker |
 |  [namespace](./browser-tracker.browsertracker.namespace.md) | string | The tracker namespace |

diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md b/trackers/browser-tracker/docs/markdown/browser-tracker.builtincontexts.md
@@ -12,5 +12,7 @@ type BuiltInContexts = RequireAtLeastOne<{
     webPage: boolean;
     /* Toggles the session context */
     session: boolean;
+    /* Toggles the browser context */
+    browser: boolean;
 }> | Record<string, never>;
 ```