v-plausible/dist/module.d.ts

Plausible Analytics plugin for Vue or Nuxt

import * as _nuxt_schema from '@nuxt/schema';
import Plausible, { PlausibleOptions } from 'plausible-tracker';

interface OptionPlugin {
    /**
     * Plausible options
     * @type PlausibleOptions
     */
    init: PlausibleOptions;
    /**
     * Plausible Settings
     * @type InstallOptions
     */
    settings: InstallOptions;
    /**
     * Partytown support
     * @default false
     * @type boolean
     * @link https://partytown.builder.io/how-does-partytown-work
     */
    partytown?: boolean;
}
interface InstallOptions {
    /**
     * Enables automatic page view tracking for SPAs
     * @default false
     * @see https://github.com/plausible/plausible-tracker
     * @type boolean
     */
    enableAutoPageviews?: boolean;
    /**
     * Outbound link click tracking
     * @default false
     * @see https://plausible.io/docs/outbound-link-click-tracking
     * @type boolean
     *
     */
    enableAutoOutboundTracking?: boolean;
}
declare module '@vue/runtime-core' {
    interface ComponentCustomProperties {
        $plausible: ReturnType<typeof Plausible>;
    }
}

interface ModuleOptions extends OptionPlugin {
}
declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;

declare module '@nuxt/schema' {
    interface ConfigSchema {
        publicRuntimeConfig?: {
            plausible?: ModuleOptions;
        };
    }
}

export { type ModuleOptions, _default as default };