posthog-js/dist/src/extensions/browser-client.d.ts

Posthog-js allows you to automatically capture usage and send events to PostHog.

import type { ApiResponse, CaptureOptions as BrowserCommonCaptureOptions, CapturedEventInfo, Client, DeepReadonly, Disposable, Extension, ExtensionToken, KeyValueStore, Listener, SendRequestInit, SessionContext } from '@posthog/browser-common';
import { type Logger } from '@posthog/core';
import type { PostHog } from '../posthog-core';
import type { Properties, RemoteConfigResult } from '../types';
/** A capability view of a PostHog instance. The instance owns extension lifecycle. */
export declare class BrowserClientAdapter implements Client {
    readonly instance: PostHog;
    readonly kv: KeyValueStore;
    readonly onSession: Listener<string>;
    readonly onEvent: Listener<CapturedEventInfo>;
    readonly onRemoteConfig: Listener<DeepReadonly<RemoteConfigResult>>;
    private readonly _logger;
    constructor(instance: PostHog);
    get logger(): Logger;
    get distinctId(): string;
    get anonymousId(): string;
    get deviceId(): string | undefined;
    get library(): {
        name: string;
        version: string;
    };
    get initialPersonProperties(): Record<string, unknown>;
    get groups(): Record<string, string>;
    get session(): SessionContext;
    get isOptedOut(): boolean;
    get canCapture(): boolean;
    get projectToken(): string;
    getExtension<T extends Extension>(token: ExtensionToken<T>): T | undefined;
    getExtension<T extends Extension = Extension>(name: string): T | undefined;
    capture(event: string, properties?: Properties | null, options?: BrowserCommonCaptureOptions): void;
    registerDynamicEventProperties(producer: () => Record<string, unknown>): Disposable;
    sendRequest(path: string, init?: SendRequestInit): Promise<ApiResponse>;
}