Skip to content

Commit 8715335

Browse files
Applying documentation updates.
1 parent b7e0f9b commit 8715335

8 files changed

+36
-10
lines changed

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Get the cookie name as cookieNamePrefix + basename + . + domain.
99
<b>Signature:</b>
1010

1111
```typescript
12-
getCookieName: (basename: string) => void;
12+
getCookieName: (basename: string) => string;
1313
```

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Get the domain session index also known as current memorized visit count.
99
<b>Signature:</b>
1010

1111
```typescript
12-
getDomainSessionIndex: () => void;
12+
getDomainSessionIndex: () => number;
1313
```

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Get visitor ID (from first party cookie)
99
<b>Signature:</b>
1010

1111
```typescript
12-
getDomainUserId: () => void;
12+
getDomainUserId: () => string;
1313
```

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Get the visitor information (from first party cookie)
99
<b>Signature:</b>
1010

1111
```typescript
12-
getDomainUserInfo: () => void;
12+
getDomainUserInfo: () => ParsedIdCookie;
1313
```

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ Get the current user ID (as set previously with setUserId()).
99
<b>Signature:</b>
1010

1111
```typescript
12-
getUserId: () => void;
12+
getUserId: () => string | null | undefined;
1313
```

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ interface BrowserTracker
2929
| [enableActivityTrackingCallback](./browser-tracker.browsertracker.enableactivitytrackingcallback.md) | (configuration: ActivityTrackingConfiguration &amp; ActivityTrackingConfigurationCallback) =&gt; void | Enables page activity tracking (replaces collector ping with callback). |
3030
| [enableAnonymousTracking](./browser-tracker.browsertracker.enableanonymoustracking.md) | (configuration?: EnableAnonymousTrackingConfiguration) =&gt; void | Enables anonymous tracking (ie. tracker initialized without <code>anonymousTracking</code>) |
3131
| [flushBuffer](./browser-tracker.browsertracker.flushbuffer.md) | (configuration?: FlushBufferConfiguration) =&gt; void | Send all events in the outQueue Only need to use this when sending events with a bufferSize of at least 2 |
32-
| [getCookieName](./browser-tracker.browsertracker.getcookiename.md) | (basename: string) =&gt; void | Get the cookie name as cookieNamePrefix + basename + . + domain. |
33-
| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () =&gt; void | Get the domain session index also known as current memorized visit count. |
34-
| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () =&gt; void | Get visitor ID (from first party cookie) |
35-
| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () =&gt; void | Get the visitor information (from first party cookie) |
32+
| [getCookieName](./browser-tracker.browsertracker.getcookiename.md) | (basename: string) =&gt; string | Get the cookie name as cookieNamePrefix + basename + . + domain. |
33+
| [getDomainSessionIndex](./browser-tracker.browsertracker.getdomainsessionindex.md) | () =&gt; number | Get the domain session index also known as current memorized visit count. |
34+
| [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) | () =&gt; string | Get visitor ID (from first party cookie) |
35+
| [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) | () =&gt; ParsedIdCookie | Get the visitor information (from first party cookie) |
3636
| [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) | () =&gt; string | Get the current page view ID |
3737
| [getTabId](./browser-tracker.browsertracker.gettabid.md) | () =&gt; string \| null | Get the current browser tab ID |
38-
| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () =&gt; void | Get the current user ID (as set previously with setUserId()). |
38+
| [getUserId](./browser-tracker.browsertracker.getuserid.md) | () =&gt; string \| null \| undefined | Get the current user ID (as set previously with setUserId()). |
3939
| [id](./browser-tracker.browsertracker.id.md) | string | The unique identifier of this tracker |
4040
| [namespace](./browser-tracker.browsertracker.namespace.md) | string | The tracker namespace |
4141
| [newSession](./browser-tracker.browsertracker.newsession.md) | () =&gt; void | Expires current session and starts a new session. |

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

+1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
| [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md) | |
9191
| [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) |
9292
| [GetBatch](./browser-tracker.getbatch.md) | A collection of GET events which are sent to the collector. This will be a collection of query strings. |
93+
| [ParsedIdCookie](./browser-tracker.parsedidcookie.md) | The format of state elements stored in the <code>id</code> cookie. |
9394
| [Platform](./browser-tracker.platform.md) | |
9495
| [PostBatch](./browser-tracker.postbatch.md) | A collection of POST events which are sent to the collector. This will be a collection of JSON objects. |
9596
| [RequestFailure](./browser-tracker.requestfailure.md) | The data that will be available to the <code>onRequestFailure</code> callback |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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; [ParsedIdCookie](./browser-tracker.parsedidcookie.md)
4+
5+
## ParsedIdCookie type
6+
7+
The format of state elements stored in the `id` cookie.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
type ParsedIdCookie = [
13+
cookieDisabled: string,
14+
domainUserId: string,
15+
cookieCreateTs: number,
16+
visitCount: number,
17+
nowTs: number,
18+
lastVisitTs: number | undefined,
19+
sessionId: string,
20+
previousSessionId: string,
21+
firstEventId: string,
22+
firstEventTs: number | undefined,
23+
eventIndex: number
24+
];
25+
```

0 commit comments

Comments
 (0)