Simplest thing might just be to add a declaration file /types.d.ts that can be referenced, e.g.,

project-root/
├── count.js           # Main implementation file
├── types.d.ts         # TypeScript declaration file
└── example.js         # Usage example file

In example.js,

// Reference the types file
/// <reference path="./types.d.ts" />

window.goatcounter.
//            ^ this is now typed by TSServer

Had Claude generate one:

types.d.ts

/**
 * Type definitions for GoatCounter
 * https://www.goatcounter.com
 */

declare namespace GoatCounter {
	/**
	 * Settings that can be defined in data-goatcounter-settings
	 */
	interface Settings {
		/** Don't automatically count page view on load */
		no_onload?: boolean;
		/** Don't bind to click events with data-goatcounter-click */
		no_events?: boolean;
		/** Allow local development (localhost) to be counted */
		allow_local?: boolean;
		/** Allow counting in iframes */
		allow_frame?: boolean;
		/** Override the path to count */
		path?: string | ((path: string) => string | null);
		/** Override the title to count */
		title?: string | ((title: string) => string);
		/** Override the referrer to count */
		referrer?: string | ((referrer: string) => string);
		/** Count as an event rather than a pageview */
		event?: boolean;
	}

	/**
	 * Optional parameters for counting hits
	 */
	interface CountVars {
		/** Override the path to count */
		path?: string | ((path: string) => string | null);
		/** Override the title to count */
		title?: string | ((title: string) => string);
		/** Override the referrer to count */
		referrer?: string | ((referrer: string) => string);
		/** Count as an event rather than a pageview */
		event?: boolean;
	}

	/**
	 * Options for visit_count
	 */
	interface VisitCountOptions {
		/** Output type: 'html', 'svg', or 'png'; defaults to 'html' */
		type?: "html" | "svg" | "png";
		/** CSS selector to append the counter to; defaults to 'body' */
		append?: string;
		/** Path to count; defaults to current path */
		path?: string;
		/** Set to true to hide GoatCounter branding */
		no_branding?: boolean;
		/** CSS styling */
		style?: string;
		/** Count since this date */
		start?: string;
		/** Count until this date */
		end?: string;
		/** HTML attributes to set on the element */
		attr?: Record<string, string>;
	}
}

interface Window {
	/** GoatCounter analytics object */
	goatcounter: {
		/** Don't automatically count page view on load */
		no_onload?: boolean;
		/** Don't bind to click events with data-goatcounter-click */
		no_events?: boolean;
		/** Allow local development (localhost) to be counted */
		allow_local?: boolean;
		/** Allow counting in iframes */
		allow_frame?: boolean;
		/** Override the path to count */
		path?: string | ((path: string) => string | null);
		/** Override the title to count */
		title?: string | ((title: string) => string);
		/** Override the referrer to count */
		referrer?: string | ((referrer: string) => string);
		/** Count as an event rather than a pageview */
		event?: boolean;
		/** The endpoint to send requests to */
		endpoint?: string;

		/**
		 * Filter some requests that we (probably) don't want to count
		 * @returns False if the request should be counted, or a string reason if it should be filtered
		 */
		filter(): string | false;

		/**
		 * Get URL to send to GoatCounter
		 * @param vars Optional variables to override default parameters
		 * @returns The URL to send to GoatCounter, or undefined if endpoint is not found
		 */
		url(vars?: GoatCounter.CountVars): string | undefined;

		/**
		 * Count a hit
		 * @param vars Optional variables to override default parameters
		 */
		count(vars?: GoatCounter.CountVars): void;

		/**
		 * Get a query parameter
		 * @param name Name of the query parameter
		 * @returns Value of the query parameter
		 */
		get_query(name: string): string | undefined;

		/**
		 * Track click events by binding to elements with data-goatcounter-click
		 */
		bind_events(): void;

		/**
		 * Add a "visitor counter" frame or image
		 * @param opt Options for the counter
		 */
		visit_count(opt?: GoatCounter.VisitCountOptions): void;
	};

	/** Legacy compatibility with older versions */
	counter?: string;
}

Uh oh!

TypeScript definitions #789

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions