Add link to Track Screenviews dev doc.

firebase · May 16, 2022 · f561e54 · f561e54
1 parent a09d26c
commit f561e54
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 1 deletion.
diff --git a/packages/analytics-compat/src/service.ts b/packages/analytics-compat/src/service.ts
@@ -45,7 +45,10 @@ export class AnalyticsService implements FirebaseAnalytics, _FirebaseService {
     logEventExp(this._delegate, eventName as '', eventParams, options);
   }
 
-  /** @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`. */
+  /**
+   * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+   * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
+   */
   setCurrentScreen(screenName: string, options?: AnalyticsCallOptions): void {
     setCurrentScreenExp(this._delegate, screenName, options);
   }

diff --git a/packages/analytics-types/index.d.ts b/packages/analytics-types/index.d.ts
@@ -455,6 +455,7 @@ export interface FirebaseAnalytics {
    * Use gtag 'config' command to set 'screen_name'.
    *
    * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+   * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
    */
   setCurrentScreen(screenName: string, options?: AnalyticsCallOptions): void;
 

diff --git a/packages/analytics/src/api.ts b/packages/analytics/src/api.ts
@@ -145,6 +145,7 @@ export async function isSupported(): Promise<boolean> {
  * @public
  *
  * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+ * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
  *
  * @param analyticsInstance - The {@link Analytics} instance.
  * @param screenName - Screen name to set.

diff --git a/packages/analytics/src/functions.ts b/packages/analytics/src/functions.ts
@@ -54,6 +54,7 @@ export async function logEvent(
  * Set screen_name parameter for this Google Analytics ID.
  *
  * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+ * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
  *
  * @param gtagFunction Wrapped gtag function that waits for fid to be set before sending an event
  * @param screenName Screen name string to set.

diff --git a/packages/firebase/compat/index.d.ts b/packages/firebase/compat/index.d.ts
@@ -5217,6 +5217,7 @@ declare namespace firebase.analytics {
      * Use gtag 'config' command to set 'screen_name'.
      *
      * @deprecated Use {@link logEvent} with `eventName` as 'screen_view' and add relevant `eventParams`.
+     * See {@link https://firebase.google.com/docs/analytics/screenviews | Track Screenviews}.
      */
     setCurrentScreen(
       screenName: string,