diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.md index 66ea8d974..79a214fa9 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.md @@ -88,7 +88,7 @@ | [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) | | [Platform](./browser-tracker.platform.md) | | | [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) | -| [SelfDescribingJson](./browser-tracker.selfdescribingjson.md) | export interface for any Self-Describing JSON such as context or Self Describing events | +| [SelfDescribingJson](./browser-tracker.selfdescribingjson.md) | Export interface for any Self-Describing JSON such as context or Self Describing events | | [StateStorageStrategy](./browser-tracker.statestoragestrategy.md) | | | [TrackerConfiguration](./browser-tracker.trackerconfiguration.md) | The configuration object for initialising the tracker | diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingjson.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingjson.md index 2e11754c5..8d2fceddb 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingjson.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingjson.md @@ -4,7 +4,7 @@ ## SelfDescribingJson type -export interface for any Self-Describing JSON such as context or Self Describing events +Export interface for any Self-Describing JSON such as context or Self Describing events Signature: diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md index 7c9272b65..da5d9a077 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md +++ b/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentgranted.md @@ -26,7 +26,7 @@ declare function buildConsentGranted(event: ConsentGrantedEvent): { Returns: -`{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; }` +{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; } An object containing the PayloadBuilder to be sent to and a 'consent\_document' context diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md b/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md index 9c6128a27..dc59cff79 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md +++ b/api-docs/docs/node-tracker/markdown/node-tracker.buildconsentwithdrawn.md @@ -26,7 +26,7 @@ declare function buildConsentWithdrawn(event: ConsentWithdrawnEvent): { Returns: -`{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; }` +{ event: PayloadBuilder; context: { schema: string; data: Record<string, unknown>; }\[\]; } An object containing the PayloadBuilder to be sent to and a 'consent\_document' context diff --git a/api-docs/docs/node-tracker/markdown/node-tracker.md b/api-docs/docs/node-tracker/markdown/node-tracker.md index 6802206e8..e9dca05bf 100644 --- a/api-docs/docs/node-tracker/markdown/node-tracker.md +++ b/api-docs/docs/node-tracker/markdown/node-tracker.md @@ -25,7 +25,7 @@ | [buildEcommerceTransactionItem(event)](./node-tracker.buildecommercetransactionitem.md) | Build an Ecommerce Transaction Item Event Related to the [buildEcommerceTransaction()](./node-tracker.buildecommercetransaction.md) Each Ecommerce Transaction may contain one or more EcommerceTransactionItem events | | [buildFormFocusOrChange(event)](./node-tracker.buildformfocusorchange.md) | Build a Form Focus or Change Form Event based on schema property When a user focuses on a form element or when a user makes a change to a form element. | | [buildFormSubmission(event)](./node-tracker.buildformsubmission.md) | Build a Form Submission Event Used to track when a user submits a form | -| [buildLinkClick(event)](./node-tracker.buildlinkclick.md) | Build a Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag `` | +| [buildLinkClick(event)](./node-tracker.buildlinkclick.md) | Build a Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag <a> | | [buildPagePing(event)](./node-tracker.buildpageping.md) | Build a Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view | | [buildPageView(event)](./node-tracker.buildpageview.md) | Build a Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA). | | [buildRemoveFromCart(event)](./node-tracker.buildremovefromcart.md) | Build a Remove From Cart Event For tracking users removing items from a cart on an ecommerce site. | @@ -55,7 +55,7 @@ | [Emitter](./node-tracker.emitter.md) | | | [FormFocusOrChangeEvent](./node-tracker.formfocusorchangeevent.md) | Represents either a Form Focus or Form Change event When a user focuses on a form element or when a user makes a change to a form element. | | [FormSubmissionEvent](./node-tracker.formsubmissionevent.md) | A Form Submission Event Used to track when a user submits a form | -| [LinkClickEvent](./node-tracker.linkclickevent.md) | A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag `` | +| [LinkClickEvent](./node-tracker.linkclickevent.md) | A Link Click Event Used when a user clicks on a link on a webpage, typically an anchor tag <a> | | [PagePingEvent](./node-tracker.pagepingevent.md) | A Page Ping Event Fires when activity tracking is enabled in the browser. Tracks same information as the last tracked Page View and includes scroll information from the current page view | | [PageViewEvent](./node-tracker.pageviewevent.md) | A Page View Event Represents a Page View, which is typically fired as soon as possible when a web page is loaded within the users browser. Often also fired on "virtual page views" within Single Page Applications (SPA). | | [PayloadBuilder](./node-tracker.payloadbuilder.md) | Interface for mutable object encapsulating tracker payload |