Skip to content

Commit a377d94

Browse files
Applying documentation updates.
1 parent 11ce5b2 commit a377d94

6 files changed

+63
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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; [EventBatch](./browser-tracker.eventbatch.md)
4+
5+
## EventBatch type
6+
7+
A collection of events which are sent to the collector. This can either be a collection of query strings or JSON objects.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
type EventBatch = GetBatch | PostBatch;
13+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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; [GetBatch](./browser-tracker.getbatch.md)
4+
5+
## GetBatch type
6+
7+
A collection of GET events which are sent to the collector. This will be a collection of query strings.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
type GetBatch = string[];
13+
```

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

+4
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,13 @@
8484
| [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 |
8585
| [ContextPrimitive](./browser-tracker.contextprimitive.md) | A context primitive is either a self-describing JSON or a context generator |
8686
| [CookieSameSite](./browser-tracker.cookiesamesite.md) | |
87+
| [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. |
8788
| [EventMethod](./browser-tracker.eventmethod.md) | |
8889
| [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) |
90+
| [GetBatch](./browser-tracker.getbatch.md) | A collection of GET events which are sent to the collector. This will be a collection of query strings. |
8991
| [Platform](./browser-tracker.platform.md) | |
92+
| [PostBatch](./browser-tracker.postbatch.md) | A collection of POST events which are sent to the collector. This will be a collection of JSON objects. |
93+
| [RequestFailure](./browser-tracker.requestfailure.md) | The data that will be available to the <code>onRequestFailure</code> callback |
9094
| [RuleSetProvider](./browser-tracker.rulesetprovider.md) | A ruleset provider is aa tuple that has two parts: a ruleset and the context primitive(s) If the ruleset allows the current event schema URI, the tracker will attach the context primitive(s) |
9195
| [SelfDescribingJson](./browser-tracker.selfdescribingjson.md) | Export interface for any Self-Describing JSON such as context or Self Describing events |
9296
| [StateStorageStrategy](./browser-tracker.statestoragestrategy.md) | |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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; [PostBatch](./browser-tracker.postbatch.md)
4+
5+
## PostBatch type
6+
7+
A collection of POST events which are sent to the collector. This will be a collection of JSON objects.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
type PostBatch = Record<string, unknown>[];
13+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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; [RequestFailure](./browser-tracker.requestfailure.md)
4+
5+
## RequestFailure type
6+
7+
The data that will be available to the `onRequestFailure` callback
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
type RequestFailure = {
13+
events: EventBatch;
14+
status?: number;
15+
message?: string;
16+
willRetry: boolean;
17+
};
18+
```

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

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ type TrackerConfiguration = {
4242
onSessionUpdateCallback?: (updatedSession: ClientSession) => void;
4343
idService?: string;
4444
retryFailedRequests?: boolean;
45+
onRequestSuccess?: (data: EventBatch) => void;
46+
onRequestFailure?: (data: RequestFailure) => void;
4547
};
4648
```
4749

0 commit comments

Comments
 (0)