wip

segmentio · Aug 21, 2023 · 3ff17d4 · 3ff17d4
1 parent 4107e9d
commit 3ff17d4
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/packages/consent/consent-tools/src/types/wrapper.ts b/packages/consent/consent-tools/src/types/wrapper.ts
@@ -39,7 +39,7 @@ export interface AnyAnalytics {
  * This function modifies an analytics instance to add consent management.
  * This is an analytics instance (either window.analytics, new AnalyticsBrowser(), or the instance returned by `AnalyticsBrowser.load({...})`
  **/
-// The chance of a false positive is higher than the chance that someone will pass in an object that is not an analytics instance.
+// Why type this as 'object' rather than 'AnyAnalytics'? IMO, the chance of a false positive is much higher than the chance that someone will pass in an object that is not an analytics instance.
 // We have an assertion function that throws an error if the analytics instance is not compatible.
 export type Wrapper = (analyticsInstance: object) => void