From 8d5a43b762212b4e07d41b5af666af02f893e8ee Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 16 Aug 2021 13:03:39 +0000 Subject: [PATCH] Applying documentation updates. --- .../docs/markdown/browser-tracker.browsertracker.md | 4 ++-- .../browser-tracker.browsertracker.setoptoutcookie.md | 2 +- .../docs/markdown/browser-tracker.browsertracker.setuserid.md | 2 +- .../docs/markdown/browser-tracker.setoptoutcookie.md | 4 ++-- .../docs/markdown/browser-tracker.setuserid.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md index 61329a20b..2de80b0d3 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.md @@ -42,9 +42,9 @@ interface BrowserTracker | [setCookiePath](./browser-tracker.browsertracker.setcookiepath.md) | (path: string) => void | Set first-party cookie path | | [setCustomUrl](./browser-tracker.browsertracker.setcustomurl.md) | (url: string) => void | Override url | | [setDocumentTitle](./browser-tracker.browsertracker.setdocumenttitle.md) | (title: string) => void | Override document.title | -| [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) | (name: string) => void | Sets the opt out cookie. | +| [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) | (name?: string \| null) => void | Sets the opt out cookie. | | [setReferrerUrl](./browser-tracker.browsertracker.setreferrerurl.md) | (url: string) => void | Override referrer | -| [setUserId](./browser-tracker.browsertracker.setuserid.md) | (userId: string) => void | Set the business-defined user ID for this user. | +| [setUserId](./browser-tracker.browsertracker.setuserid.md) | (userId?: string \| null) => void | Set the business-defined user ID for this user. | | [setUserIdFromCookie](./browser-tracker.browsertracker.setuseridfromcookie.md) | (cookieName: string) => void | Set the business-defined user ID for this user to the value of a cookie. | | [setUserIdFromLocation](./browser-tracker.browsertracker.setuseridfromlocation.md) | (querystringField: string) => void | Set the business-defined user ID for this user using the location querystring. | | [setUserIdFromReferrer](./browser-tracker.browsertracker.setuseridfromreferrer.md) | (querystringField: string) => void | Set the business-defined user ID for this user using the referrer querystring. | diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md index b3b4c5efc..fba5b9aa6 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setoptoutcookie.md @@ -9,5 +9,5 @@ Sets the opt out cookie. Signature: ```typescript -setOptOutCookie: (name: string) => void; +setOptOutCookie: (name?: string | null) => void; ``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md index f7fbcff6d..020656273 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.browsertracker.setuserid.md @@ -9,5 +9,5 @@ Set the business-defined user ID for this user. Signature: ```typescript -setUserId: (userId: string) => void; +setUserId: (userId?: string | null) => void; ``` diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md index 300db1b61..8b1e2487e 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.setoptoutcookie.md @@ -9,14 +9,14 @@ Sets the opt out cookie. Signature: ```typescript -declare function setOptOutCookie(name: string, trackers?: Array): void; +declare function setOptOutCookie(name?: string | null, trackers?: Array): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| name | string | of the opt out cookie | +| name | string \| null | of the opt out cookie | | trackers | Array<string> | The tracker identifiers which will be configured | Returns: diff --git a/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md b/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md index a8b7d8f90..1125648b8 100644 --- a/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md +++ b/trackers/browser-tracker/docs/markdown/browser-tracker.setuserid.md @@ -9,14 +9,14 @@ Set the business-defined user ID for this user. Signature: ```typescript -declare function setUserId(userId: string, trackers?: Array): void; +declare function setUserId(userId?: string | null, trackers?: Array): void; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| userId | string | The business-defined user ID | +| userId | string \| null | The business-defined user ID | | trackers | Array<string> | The tracker identifiers which will be configured | Returns: