From 781cadb9a4ffc3dd60c8f7dfd506680a6f7205e5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 24 Jul 2024 09:02:38 +0000 Subject: [PATCH] Applying documentation updates. --- ...-tracker.eventpayloadandcontext.context.md | 26 ++++++------ ...er-tracker.eventpayloadandcontext.event.md | 26 ++++++------ .../browser-tracker.eventpayloadandcontext.md | 42 +++++++++---------- ...-tracker.eventpayloadandcontext.context.md | 26 ++++++------ ...de-tracker.eventpayloadandcontext.event.md | 26 ++++++------ .../node-tracker.eventpayloadandcontext.md | 42 +++++++++---------- 6 files changed, 94 insertions(+), 94 deletions(-) diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.context.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.context.md index 977152701..9f950fa9f 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.context.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.context.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) > [context](./browser-tracker.eventpayloadandcontext.context.md) - -## EventPayloadAndContext.context property - -List of context entities to track along with the event - -Signature: - -```typescript -context: Array; -``` + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) > [context](./browser-tracker.eventpayloadandcontext.context.md) + +## EventPayloadAndContext.context property + +List of context entities to track along with the event + +Signature: + +```typescript +context: Array; +``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.event.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.event.md index 6954679dd..3a977651c 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.event.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.event.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) > [event](./browser-tracker.eventpayloadandcontext.event.md) - -## EventPayloadAndContext.event property - -Tracker payload for the event data - -Signature: - -```typescript -event: PayloadBuilder; -``` + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) > [event](./browser-tracker.eventpayloadandcontext.event.md) + +## EventPayloadAndContext.event property + +Tracker payload for the event data + +Signature: + +```typescript +event: PayloadBuilder; +``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.md index f1f51ca19..7b13345a5 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) - -## EventPayloadAndContext interface - -Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). - -Signature: - -```typescript -interface EventPayloadAndContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](./browser-tracker.eventpayloadandcontext.context.md) | Array<SelfDescribingJson> | List of context entities to track along with the event | -| [event](./browser-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data | - + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) + +## EventPayloadAndContext interface + +Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). + +Signature: + +```typescript +interface EventPayloadAndContext +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context](./browser-tracker.eventpayloadandcontext.context.md) | Array<SelfDescribingJson> | List of context entities to track along with the event | +| [event](./browser-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data | + diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md index 92840df88..450dac748 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md +++ b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.context.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) > [context](./node-tracker.eventpayloadandcontext.context.md) - -## EventPayloadAndContext.context property - -List of context entities to track along with the event - -Signature: - -```typescript -context: Array; -``` + + +[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) > [context](./node-tracker.eventpayloadandcontext.context.md) + +## EventPayloadAndContext.context property + +List of context entities to track along with the event + +Signature: + +```typescript +context: Array; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md index 4d9da8eb3..75e3aad07 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md +++ b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.event.md @@ -1,13 +1,13 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) > [event](./node-tracker.eventpayloadandcontext.event.md) - -## EventPayloadAndContext.event property - -Tracker payload for the event data - -Signature: - -```typescript -event: PayloadBuilder; -``` + + +[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) > [event](./node-tracker.eventpayloadandcontext.event.md) + +## EventPayloadAndContext.event property + +Tracker payload for the event data + +Signature: + +```typescript +event: PayloadBuilder; +``` diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md index 6e2172552..3f94b70a3 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md +++ b/api-docs/docs/node-tracker/markdown/node-tracker.eventpayloadandcontext.md @@ -1,21 +1,21 @@ - - -[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) - -## EventPayloadAndContext interface - -Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). - -Signature: - -```typescript -interface EventPayloadAndContext -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context](./node-tracker.eventpayloadandcontext.context.md) | Array<SelfDescribingJson> | List of context entities to track along with the event | -| [event](./node-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data | - + + +[Home](./index.md) > [@snowplow/node-tracker](./node-tracker.md) > [EventPayloadAndContext](./node-tracker.eventpayloadandcontext.md) + +## EventPayloadAndContext interface + +Interface for returning a built event (PayloadBuilder) and context (Array of SelfDescribingJson). + +Signature: + +```typescript +interface EventPayloadAndContext +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context](./node-tracker.eventpayloadandcontext.context.md) | Array<SelfDescribingJson> | List of context entities to track along with the event | +| [event](./node-tracker.eventpayloadandcontext.event.md) | PayloadBuilder | Tracker payload for the event data | +