@types/umami

Installation

npm install --save @types/umami

Summary

This package contains type definitions for umami (https://github.com/umami-software/umami).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/umami.

index.d.ts

declare var umami: umami.umami;

/**
 * @see {@link https://umami.is/docs/tracker-functions|Umami Docs}
 */
declare namespace umami {
    interface umami {
        track(): Promise<string> | undefined;
        track(
            event_name: string,
            event_data?: { [key: string]: any },
        ): Promise<string> | undefined;
        track(custom_payload: {
            website: string;
            [key: string]: any;
        }): Promise<string> | undefined;
        track(
            callback: (props: {
                hostname: string;
                language: string;
                referrer: string;
                screen: string;
                title: string;
                url: string;
                website: string;
            }) => { website: string; [key: string]: any },
        ): Promise<string> | undefined;

        /** Pass in your own ID to identify a user. */
        identify(identity_id: string): Promise<void>;

        /** Save data about the current session. */
        identify(
            indentity_id: string,
            data: Record<string, any>,
        ): Promise<void>;

        /** To save data without a unique ID, pass in only a JSON object. */
        identify(data: Record<string, any>): Promise<void>;
    }
}

Additional Details

• Last updated: Tue, 26 Aug 2025 15:35:28 GMT
• Dependencies: none

Credits

These definitions were written by Noah Overcash.