Skip to content

Commit d4ba8da

Browse files
authored
Fix analytics logEvent public signatures (#4469)
1 parent 261617b commit d4ba8da

File tree

2 files changed

+25
-20
lines changed

2 files changed

+25
-20
lines changed

.changeset/little-suns-train.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'firebase': patch
3+
---
4+
5+
Change the `eventParams` argument in the signature of `analytics().logEvent()` to be optional.

packages/firebase/index.d.ts

+20-20
Original file line numberDiff line numberDiff line change
@@ -4479,7 +4479,7 @@ declare namespace firebase.analytics {
44794479
*/
44804480
logEvent(
44814481
eventName: 'add_shipping_info',
4482-
eventParams: {
4482+
eventParams?: {
44834483
coupon?: EventParams['coupon'];
44844484
currency?: EventParams['currency'];
44854485
items?: EventParams['items'];
@@ -4500,7 +4500,7 @@ declare namespace firebase.analytics {
45004500
*/
45014501
logEvent(
45024502
eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart',
4503-
eventParams: {
4503+
eventParams?: {
45044504
currency?: EventParams['currency'];
45054505
value?: EventParams['value'];
45064506
items?: EventParams['items'];
@@ -4519,7 +4519,7 @@ declare namespace firebase.analytics {
45194519
*/
45204520
logEvent(
45214521
eventName: 'begin_checkout',
4522-
eventParams: {
4522+
eventParams?: {
45234523
currency?: EventParams['currency'];
45244524
coupon?: EventParams['coupon'];
45254525
value?: EventParams['value'];
@@ -4539,7 +4539,7 @@ declare namespace firebase.analytics {
45394539
*/
45404540
logEvent(
45414541
eventName: 'checkout_progress',
4542-
eventParams: {
4542+
eventParams?: {
45434543
currency?: EventParams['currency'];
45444544
coupon?: EventParams['coupon'];
45454545
value?: EventParams['value'];
@@ -4561,7 +4561,7 @@ declare namespace firebase.analytics {
45614561
*/
45624562
logEvent(
45634563
eventName: 'exception',
4564-
eventParams: {
4564+
eventParams?: {
45654565
description?: EventParams['description'];
45664566
fatal?: EventParams['fatal'];
45674567
[key: string]: any;
@@ -4579,7 +4579,7 @@ declare namespace firebase.analytics {
45794579
*/
45804580
logEvent(
45814581
eventName: 'generate_lead',
4582-
eventParams: {
4582+
eventParams?: {
45834583
value?: EventParams['value'];
45844584
currency?: EventParams['currency'];
45854585
transaction_id?: EventParams['transaction_id'];
@@ -4598,7 +4598,7 @@ declare namespace firebase.analytics {
45984598
*/
45994599
logEvent(
46004600
eventName: 'login',
4601-
eventParams: {
4601+
eventParams?: {
46024602
method?: EventParams['method'];
46034603
[key: string]: any;
46044604
},
@@ -4615,7 +4615,7 @@ declare namespace firebase.analytics {
46154615
*/
46164616
logEvent(
46174617
eventName: 'page_view',
4618-
eventParams: {
4618+
eventParams?: {
46194619
page_title?: string;
46204620
page_location?: string;
46214621
page_path?: string;
@@ -4634,7 +4634,7 @@ declare namespace firebase.analytics {
46344634
*/
46354635
logEvent(
46364636
eventName: 'purchase' | 'refund',
4637-
eventParams: {
4637+
eventParams?: {
46384638
value?: EventParams['value'];
46394639
currency?: EventParams['currency'];
46404640
transaction_id: EventParams['transaction_id'];
@@ -4658,7 +4658,7 @@ declare namespace firebase.analytics {
46584658
*/
46594659
logEvent(
46604660
eventName: 'screen_view',
4661-
eventParams: {
4661+
eventParams?: {
46624662
app_name: string;
46634663
screen_name: EventParams['screen_name'];
46644664
app_id?: string;
@@ -4679,7 +4679,7 @@ declare namespace firebase.analytics {
46794679
*/
46804680
logEvent(
46814681
eventName: 'search' | 'view_search_results',
4682-
eventParams: {
4682+
eventParams?: {
46834683
search_term?: EventParams['search_term'];
46844684
[key: string]: any;
46854685
},
@@ -4696,7 +4696,7 @@ declare namespace firebase.analytics {
46964696
*/
46974697
logEvent(
46984698
eventName: 'select_content',
4699-
eventParams: {
4699+
eventParams?: {
47004700
items?: EventParams['items'];
47014701
promotions?: EventParams['promotions'];
47024702
content_type?: EventParams['content_type'];
@@ -4716,7 +4716,7 @@ declare namespace firebase.analytics {
47164716
*/
47174717
logEvent(
47184718
eventName: 'select_item',
4719-
eventParams: {
4719+
eventParams?: {
47204720
items?: EventParams['items'];
47214721
item_list_name?: EventParams['item_list_name'];
47224722
item_list_id?: EventParams['item_list_id'];
@@ -4735,7 +4735,7 @@ declare namespace firebase.analytics {
47354735
*/
47364736
logEvent(
47374737
eventName: 'select_promotion' | 'view_promotion',
4738-
eventParams: {
4738+
eventParams?: {
47394739
items?: EventParams['items'];
47404740
promotion_id?: EventParams['promotion_id'];
47414741
promotion_name?: EventParams['promotion_name'];
@@ -4754,7 +4754,7 @@ declare namespace firebase.analytics {
47544754
*/
47554755
logEvent(
47564756
eventName: 'set_checkout_option',
4757-
eventParams: {
4757+
eventParams?: {
47584758
checkout_step?: EventParams['checkout_step'];
47594759
checkout_option?: EventParams['checkout_option'];
47604760
[key: string]: any;
@@ -4772,7 +4772,7 @@ declare namespace firebase.analytics {
47724772
*/
47734773
logEvent(
47744774
eventName: 'share',
4775-
eventParams: {
4775+
eventParams?: {
47764776
method?: EventParams['method'];
47774777
content_type?: EventParams['content_type'];
47784778
content_id?: EventParams['content_id'];
@@ -4791,7 +4791,7 @@ declare namespace firebase.analytics {
47914791
*/
47924792
logEvent(
47934793
eventName: 'sign_up',
4794-
eventParams: {
4794+
eventParams?: {
47954795
method?: EventParams['method'];
47964796
[key: string]: any;
47974797
},
@@ -4808,7 +4808,7 @@ declare namespace firebase.analytics {
48084808
*/
48094809
logEvent(
48104810
eventName: 'timing_complete',
4811-
eventParams: {
4811+
eventParams?: {
48124812
name: string;
48134813
value: number;
48144814
event_category?: string;
@@ -4828,7 +4828,7 @@ declare namespace firebase.analytics {
48284828
*/
48294829
logEvent(
48304830
eventName: 'view_cart' | 'view_item',
4831-
eventParams: {
4831+
eventParams?: {
48324832
currency?: EventParams['currency'];
48334833
items?: EventParams['items'];
48344834
value?: EventParams['value'];
@@ -4847,7 +4847,7 @@ declare namespace firebase.analytics {
48474847
*/
48484848
logEvent(
48494849
eventName: 'view_item_list',
4850-
eventParams: {
4850+
eventParams?: {
48514851
items?: EventParams['items'];
48524852
item_list_name?: EventParams['item_list_name'];
48534853
item_list_id?: EventParams['item_list_id'];

0 commit comments

Comments
 (0)