From a608ead2e99bcb399a1763376619eaba55fdf9c5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 10 Jun 2022 19:01:32 +0000 Subject: [PATCH] Applying documentation updates. --- .../browser-tracker.trackerconfiguration.md | 3 +++ .../node-tracker.payloadbuilder.addcontextentity.md | 13 +++++++++++++ .../docs/markdown/node-tracker.payloadbuilder.md | 1 + 3 files changed, 17 insertions(+) create mode 100644 trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md b/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md index 8b964078b..c9b080c81 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.trackerconfiguration.md @@ -36,9 +36,12 @@ type TrackerConfiguration = { anonymousTracking?: AnonymousTrackingOptions; contexts?: { webPage: boolean; + session: boolean; }; plugins?: Array; customHeaders?: Record; + retryStatusCodes?: number[]; + dontRetryStatusCodes?: number[]; }; ``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md new file mode 100644 index 000000000..84929af64 --- /dev/null +++ b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.addcontextentity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [PayloadBuilder](./node-tracker.payloadbuilder.md) > [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) + +## PayloadBuilder.addContextEntity property + +Caches a context entity to be added to payload on build + +Signature: + +```typescript +addContextEntity: (entity: SelfDescribingJson) => void; +``` diff --git a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md index bc7690369..ecda8875f 100644 --- a/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md +++ b/trackers/node-tracker/docs/markdown/node-tracker.payloadbuilder.md @@ -17,6 +17,7 @@ interface PayloadBuilder | Property | Type | Description | | --- | --- | --- | | [add](./node-tracker.payloadbuilder.add.md) | (key: string, value: unknown) => void | Adds an entry to the Payload | +| [addContextEntity](./node-tracker.payloadbuilder.addcontextentity.md) | (entity: SelfDescribingJson) => void | Caches a context entity to be added to payload on build | | [addDict](./node-tracker.payloadbuilder.adddict.md) | (dict: Payload) => void | Merges a payload into the existing payload | | [addJson](./node-tracker.payloadbuilder.addjson.md) | (keyIfEncoded: string, keyIfNotEncoded: string, json: Record<string, unknown>) => void | Caches a JSON object to be added to payload on build | | [build](./node-tracker.payloadbuilder.build.md) | () => Payload | Builds and returns the Payload |