Skip to content

Commit eb2e151

Browse files
fix(analytics): change method return types from void to Promise<void> (#2409)
Co-authored-by: Patryk Kuniczak <p.kuniczak@gmail.com>
1 parent b235c85 commit eb2e151

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

packages/analytics/modules/analytics/client.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ type AnalyticsMethod =
2525

2626
type MethodForwarder = <K extends keyof Analytics>(
2727
fn: K,
28-
) => (...args: Parameters<Analytics[K]>) => void;
28+
) => (...args: Parameters<Analytics[K]>) => Promise<void>;
2929

3030
const ANALYTICS_PORT = '@wxt-dev/analytics';
3131

@@ -242,6 +242,7 @@ function createFrontendAnalytics(): Analytics {
242242
(fn) =>
243243
(...args) => {
244244
port.postMessage({ fn, args: [...args, getFrontendMetadata()] });
245+
return Promise.resolve();
245246
};
246247

247248
const analytics: Analytics = {

packages/analytics/modules/analytics/types.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,23 @@
11
export interface Analytics {
22
/** Report a page change. */
3-
page: (url: string) => void;
3+
page: (url: string) => Promise<void>;
44
/** Report a custom event. */
55
track: (
66
eventName: string,
77
eventProperties?: Record<string, string | undefined>,
8-
) => void;
8+
) => Promise<void>;
99
/** Save information about the user. */
10-
identify: (userId: string, userProperties?: Record<string, string>) => void;
10+
identify: (
11+
userId: string,
12+
userProperties?: Record<string, string>,
13+
) => Promise<void>;
1114
/**
1215
* Automatically setup and track user interactions, returning a function to
1316
* remove any listeners that were setup.
1417
*/
1518
autoTrack: (root: Document | ShadowRoot | Element) => () => void;
1619
/** Calls `config.enabled.setValue`. */
17-
setEnabled: (enabled: boolean) => void;
20+
setEnabled: (enabled: boolean) => Promise<void>;
1821
}
1922

2023
export interface AnalyticsConfig {

0 commit comments

Comments
 (0)