@nuxt/telemetry/dist/module.d.mts

Nuxt collects anonymous telemetry data about general usage. This helps us to accurately gauge Nuxt feature usage and customization across all our users.

import * as _nuxt_schema from '@nuxt/schema';
import { Nuxt } from '@nuxt/schema';
import { Nitro } from 'nitropack';

interface TelemetryOptions {
    debug: boolean;
    endpoint: string;
    seed: string;
    consent?: number;
    enabled: boolean;
}
interface Context {
    nuxt: Nuxt;
    cli: string;
    seed: string;
    projectHash: string;
    projectSession: string;
    nuxtVersion: string;
    nuxtMajorVersion: number;
    isEdge: boolean;
    nodeVersion: string;
    os: string;
    git?: {
        url: string;
    };
    environment: string | null;
    packageManager: string;
    isAgent: boolean;
    agentName: string | null;
    concent: number;
    nitroPreset: string | null;
}
interface Event {
    name: string;
    [key: string]: any;
}
type EventFactoryResult<T> = Promise<T> | T | Promise<T>[] | T[];
type EventFactory<T extends Event> = (context: Context, payload: any) => EventFactoryResult<T>;

declare class Telemetry {
    nuxt: Nuxt;
    nitro: Nitro;
    options: Required<TelemetryOptions>;
    storage: any;
    _contextPromise?: Promise<Context>;
    events: Promise<EventFactoryResult<any>>[];
    eventFactories: Record<string, EventFactory<any>>;
    constructor(nuxt: Nuxt, nitro: Nitro, options: Required<TelemetryOptions>);
    getContext(): Promise<Context>;
    createEvent(name: string, payload?: object): undefined | Promise<any>;
    _invokeEvent(name: string, eventFactory: EventFactory<any>, payload?: object): Promise<any>;
    getPublicContext(): Promise<Record<string, any>>;
    sendEvents(debug?: boolean): Promise<void>;
}

type ModuleOptions = TelemetryOptions;
interface ModuleHooks {
    'telemetry:setup': (telemetry: Telemetry) => void;
}
declare const _default: _nuxt_schema.NuxtModule<TelemetryOptions, TelemetryOptions, false>;

export { _default as default };
export type { ModuleHooks, ModuleOptions };