Class MixpanelBrowserAnalyticsClient

Hierarchy (View Summary)

BaseAnalyticsClient
- MixpanelBrowserAnalyticsClient

Index

Constructors

Methods

identify initialize mergeScope removeScope setScope trackEvent

Constructors

constructor

new MixpanelBrowserAnalyticsClient(
token: string,
options?: Partial<Config>,
): MixpanelBrowserAnalyticsClient
Parameters
- token: string
- Optionaloptions: Partial<Config>
Returns MixpanelBrowserAnalyticsClient
Overrides BaseAnalyticsClient.constructor
- Defined in clients/mixpanel/mixpanel-browser.analytics-client.ts:13

Methods

identify

identify(
userId: string,
properties: Record<string, unknown>,
): Promise<SafeError<CircleError<string, string>> | SafeSuccess<undefined>>
Parameters
- userId: string
- properties: Record<string, unknown>
Returns Promise<SafeError<CircleError<string, string>> | SafeSuccess<undefined>>
Overrides BaseAnalyticsClient.identify
- Defined in clients/mixpanel/mixpanel-browser.analytics-client.ts:39

initialize

initialize(): Promise<
SafeError<CircleError<string, string>>
| SafeSuccess<undefined>,
>
Returns Promise<SafeError<CircleError<string, string>> | SafeSuccess<undefined>>
Overrides BaseAnalyticsClient.initialize
- Defined in clients/mixpanel/mixpanel-browser.analytics-client.ts:21

`Protected`mergeScope

mergeScope(properties?: Record<string, unknown>): Record<string, unknown>
Parameters
- Optionalproperties: Record<string, unknown>
Returns Record<string, unknown>
Inherited from BaseAnalyticsClient.mergeScope
- Defined in clients/base.analytics-client.ts:25

removeScope

removeScope(key: string): void
Parameters
- key: string
Returns void
Inherited from BaseAnalyticsClient.removeScope
- Defined in clients/base.analytics-client.ts:21

setScope

setScope(key: string, value: unknown): void
Parameters
- key: string
- value: unknown
Returns void
Inherited from BaseAnalyticsClient.setScope
- Defined in clients/base.analytics-client.ts:17

trackEvent

trackEvent(
event: string,
properties?: Record<string, unknown>,
): Promise<SafeError<CircleError<string, string>> | SafeSuccess<undefined>>
Parameters
- event: string
- Optionalproperties: Record<string, unknown>
Returns Promise<SafeError<CircleError<string, string>> | SafeSuccess<undefined>>
Overrides BaseAnalyticsClient.trackEvent
- Defined in clients/mixpanel/mixpanel-browser.analytics-client.ts:53