​

Class: Analytics

Defined in: index.ts:111

​

Constructors

​

Constructor

new Analytics(): Analytics

​

Returns

Analytics

​

Accessors

​

config

​

Get Signature

get config(): Readonly<AnalyticsConfig> | null

Defined in: index.ts:116

Returns

Readonly<AnalyticsConfig> | null

---

​

posthog

​

Get Signature

get posthog(): PostHog | null

Defined in: index.ts:120

Returns

PostHog | null

​

Methods

​

identify()

identify(userId, traits?): void

Defined in: index.ts:181

​

Parameters

userId

string

traits?

Record<string, unknown>

​

Returns

void

---

​

init()

init(config): Promise<void>

Defined in: index.ts:124

​

Parameters

config

AnalyticsConfig

​

Returns

Promise<void>

---

​

pageview()

pageview(url?): void

Defined in: index.ts:211 Manually emit a pageview. Most consumers do not need to call this: PostHog’s capture_pageview: "history_change" (set in init) auto-captures SPA navigation, and GA4’s Enhanced Measurement (UI default) does the same for gtag.js. Only call manually if you’ve disabled both auto-captures, or for first-paint pageviews before init has resolved.

​

Parameters

url?

string

​

Returns

void

---

​

reset()

reset(): void

Defined in: index.ts:194

​

Returns

void

---

​

track()

track<E>(event, properties?): void

Defined in: index.ts:166

​

Type Parameters

E

E extends EventName

​

Parameters

event

E

properties?

E extends string | number ? AnalyticsEvents[E] : Record<string, unknown>

​

Returns

void