Skip to content

Commit 941467e

Browse files
authored
Remove analytics prefix from settings() (#4286)
1 parent 29555e0 commit 941467e

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

common/api-review/analytics-exp.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ import { _FirebaseService } from '@firebase/app-types-exp';
1616
import { MinimalDynamicConfig } from '@firebase/analytics-types-exp';
1717
import { SettingsOptions } from '@firebase/analytics-types-exp';
1818

19-
// @public
20-
export function analyticsSettings(options: SettingsOptions): void;
21-
2219
// @public
2320
export const enum EventName {
2421
// (undocumented)
@@ -294,6 +291,9 @@ export function setAnalyticsCollectionEnabled(analyticsInstance: Analytics, enab
294291
// @public
295292
export function setCurrentScreen(analyticsInstance: Analytics, screenName: string, options?: AnalyticsCallOptions): void;
296293

294+
// @public
295+
export function settings(options: SettingsOptions): void;
296+
297297
// @public
298298
export function setUserId(analyticsInstance: Analytics, id: string, options?: AnalyticsCallOptions): void;
299299

packages-exp/analytics-exp/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ import {
4848
setAnalyticsCollectionEnabled as internalSetAnalyticsCollectionEnabled
4949
} from './functions';
5050

51-
export { analyticsSettings } from './factory';
51+
export { settings } from './factory';
5252
export { EventName } from './constants';
5353

5454
declare module '@firebase/component' {

packages-exp/analytics-exp/src/factory.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ export function getGlobalVars(): {
144144
*
145145
* @param options - Custom gtag and dataLayer names.
146146
*/
147-
export function analyticsSettings(options: SettingsOptions): void {
147+
export function settings(options: SettingsOptions): void {
148148
if (globalInitDone) {
149149
throw ERROR_FACTORY.create(AnalyticsError.ALREADY_INITIALIZED);
150150
}

packages-exp/analytics-exp/src/index.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import { expect } from 'chai';
1919
import { SinonStub, stub, useFakeTimers } from 'sinon';
2020
import '../testing/setup';
2121
import {
22-
analyticsSettings,
22+
settings,
2323
factory as analyticsFactory,
2424
resetGlobalVars,
2525
getGlobalVars
@@ -288,7 +288,7 @@ describe('FirebaseAnalytics instance tests', () => {
288288
);
289289
window[customGtagName] = gtagStub;
290290
window[customDataLayerName] = [];
291-
analyticsSettings({
291+
settings({
292292
dataLayerName: customDataLayerName,
293293
gtagName: customGtagName
294294
});

0 commit comments

Comments
 (0)