Fix newTracker typing to accurately return null or undefined (fix #1167)

#1175
snowplow · Sep 13, 2023 · 027d539 · 027d539
1 parent 7bbb74a
commit 027d539
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 19 deletions.
diff --git a/...ser-tracker/fix-1167-correct-newTracker-function-on-browser-tracker_2023-04-17-07-28.json b/...ser-tracker/fix-1167-correct-newTracker-function-on-browser-tracker_2023-04-17-07-28.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker",
+      "comment": "Fix newTracker typing to accurately return null or undefined (fix #1167)",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker"
+}
diff --git a/trackers/browser-tracker/docs/browser-tracker.api.md b/trackers/browser-tracker/docs/browser-tracker.api.md
@@ -238,10 +238,7 @@ export interface FlushBufferConfiguration {
 export function newSession(trackers?: Array<string>): void;
 
 // @public
-export function newTracker(trackerId: string, endpoint: string): BrowserTracker;
-
-// @public
-export function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker;
+export function newTracker(trackerId: string, endpoint: string, configuration?: TrackerConfiguration): BrowserTracker | null | undefined;
 
 // @public
 export interface PageViewEvent {

diff --git a/trackers/browser-tracker/src/index.ts b/trackers/browser-tracker/src/index.ts
@@ -43,21 +43,6 @@ import { version } from '@snowplow/tracker-core';
 
 const state = typeof window !== 'undefined' ? createSharedState() : undefined;
 
-/**
- * Initialise a new tracker
- *
- * @param trackerId - The tracker id - also known as tracker namespace
- * @param endpoint - Collector endpoint in the form collector.mysite.com
- */
-export function newTracker(trackerId: string, endpoint: string): BrowserTracker;
-/**
- * Initialise a new tracker
- *
- * @param trackerId - The tracker id - also known as tracker namespace
- * @param endpoint - Collector endpoint in the form collector.mysite.com
- * @param configuration - The initialisation options of the tracker
- */
-export function newTracker(trackerId: string, endpoint: string, configuration: TrackerConfiguration): BrowserTracker;
 /**
  * Initialise a new tracker
  *