chore: rename bufferKey to globalAnalyticsKey

segmentio · Aug 23, 2023 · 55f4382 · 55f4382
1 parent 64888dc
commit 55f4382
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 4 deletions.
diff --git a/packages/browser/src/browser/__tests__/analytics-pre-init.integration.test.ts b/packages/browser/src/browser/__tests__/analytics-pre-init.integration.test.ts
@@ -287,7 +287,9 @@ describe('Pre-initialization', () => {
 
       ;(window as any).segment = [onTrack, track, track2, identify]
 
-      await AnalyticsBrowser.standalone(writeKey, { bufferKey: 'segment' })
+      await AnalyticsBrowser.standalone(writeKey, {
+        globalAnalyticsKey: 'segment',
+      })
 
       await sleep(100) // the snippet does not return a promise (pre-initialization) ... it sometimes has a callback as the third argument.
       expect(trackSpy).toBeCalledWith('foo')

diff --git a/packages/browser/src/browser/__tests__/integration.test.ts b/packages/browser/src/browser/__tests__/integration.test.ts
@@ -257,7 +257,7 @@ describe('Initialization', () => {
           ],
         },
         {
-          bufferKey: overrideKey,
+          globalAnalyticsKey: overrideKey,
         }
       )
       expect.assertions(1)

diff --git a/packages/browser/src/browser/index.ts b/packages/browser/src/browser/index.ts
@@ -291,7 +291,8 @@ async function loadAnalytics(
   options: InitOptions = {},
   preInitBuffer: PreInitMethodCallBuffer
 ): Promise<[Analytics, Context]> {
-  if (options.bufferKey) setGlobalAnalyticsKey(options.bufferKey)
+  if (options.globalAnalyticsKey)
+    setGlobalAnalyticsKey(options.globalAnalyticsKey)
   // this is an ugly side-effect, but it's for the benefits of the plugins that get their cdn via getCDN()
   if (settings.cdnURL) setGlobalCDNUrl(settings.cdnURL)
 

diff --git a/packages/browser/src/core/analytics/index.ts b/packages/browser/src/core/analytics/index.ts
@@ -121,7 +121,7 @@ export interface InitOptions {
    * Key for the global window property storing the buffered calls
    * default: analytics
    */
-  bufferKey?: string
+  globalAnalyticsKey?: string
 }
 
 /* analytics-classic stubs */