voluptasmollitia
Version:
Monorepo for the Firebase JavaScript SDK
35 lines (23 loc) • 1.51 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@firebase/analytics](./analytics.md) > [logEvent](./analytics.logevent_2.md)
## logEvent() function
Sends analytics event with given `eventParams`<!-- -->. This method automatically associates this logged event with this Firebase web app instance on this device.
List of recommended event parameters can be found in [the gtag.js reference documentation](https://developers.google.com/gtagjs/reference/event)<!-- -->.
<b>Signature:</b>
```typescript
export declare function logEvent(analyticsInstance: Analytics, eventName: 'add_to_cart' | 'add_to_wishlist' | 'remove_from_cart', eventParams?: {
currency?: EventParams['currency'];
value?: EventParams['value'];
items?: EventParams['items'];
[key: string]: any;
}, options?: AnalyticsCallOptions): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| analyticsInstance | [Analytics](./analytics.analytics.md) | |
| eventName | 'add\_to\_cart' \| 'add\_to\_wishlist' \| 'remove\_from\_cart' | |
| eventParams | { currency?: [EventParams](./analytics.eventparams.md)<!-- -->\['currency'\]; value?: [EventParams](./analytics.eventparams.md)<!-- -->\['value'\]; items?: [EventParams](./analytics.eventparams.md)<!-- -->\['items'\]; \[key: string\]: any; } | |
| options | [AnalyticsCallOptions](./analytics.analyticscalloptions.md) | |
<b>Returns:</b>
void