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 Jun 10, 2022
1 parent 30a0e1d commit a608ead
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,12 @@ type TrackerConfiguration = {
anonymousTracking?: AnonymousTrackingOptions;
contexts?: {
webPage: boolean;
session: boolean;
};
plugins?: Array<BrowserPlugin>;
customHeaders?: Record<string, string>;
retryStatusCodes?: number[];
dontRetryStatusCodes?: number[];
};
```

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@snowplow/node-tracker](./node-tracker.md) &gt; [PayloadBuilder](./node-tracker.payloadbuilder.md) &gt; [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md)

## PayloadBuilder.addContextEntity property

Caches a context entity to be added to payload on build

<b>Signature:</b>

```typescript
addContextEntity: (entity: SelfDescribingJson) => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ interface PayloadBuilder
| Property | Type | Description |
| --- | --- | --- |
| [add](./node-tracker.payloadbuilder.add.md) | (key: string, value: unknown) =&gt; void | Adds an entry to the Payload |
| [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) | (entity: SelfDescribingJson) =&gt; void | Caches a context entity to be added to payload on build |
| [addDict](./node-tracker.payloadbuilder.adddict.md) | (dict: Payload) =&gt; void | Merges a payload into the existing payload |
| [addJson](./node-tracker.payloadbuilder.addjson.md) | (keyIfEncoded: string, keyIfNotEncoded: string, json: Record&lt;string, unknown&gt;) =&gt; void | Caches a JSON object to be added to payload on build |
| [build](./node-tracker.payloadbuilder.build.md) | () =&gt; Payload | Builds and returns the Payload |
Expand Down

0 comments on commit a608ead

Please sign in to comment.