index.d.ts

import type {
	QueryArrayConfig,
	QueryArrayResult,
	QueryConfig,
	QueryConfigValues,
	QueryResult,
	QueryResultRow,
	Submittable,
} from "pg";
import type { Plugin } from "vite";

export default function postgres(opts?: {
	/**
	 * Path to a folder where all declaration are kept relative to `rootFolder`, i.e. a file at path `src/sql/module.sql` will have its `.d.ts` file generated into `${typesFolder}/src/sql/module.sql.d.ts`. Make sure you include this one in your `tsconfig.json`.
	 *
	 * @default "node_modules/@types/vite-plugin-postgres-import/"
	 */
	typesFolder?: string;
	/**
	 * Root folder relative to which path calculation will be happening. May be useful for some I guess.
	 *
	 * @default process.cwd()
	 */
	rootFolder?: string;
}): Plugin;

export interface QueryableObject {
	query<T extends Submittable>(queryStream: T): T;

	query<R extends any[] = any[], I = any[]>(
		queryConfig: QueryArrayConfig<I>,
		values?: QueryConfigValues<I>
	): Promise<QueryArrayResult<R>>;

	query<R extends QueryResultRow = any, I = any>(queryConfig: QueryConfig<I>): Promise<QueryResult<R>>;

	query<R extends QueryResultRow = any, I = any[]>(
		queryTextOrConfig: string | QueryConfig<I>,
		values?: QueryConfigValues<I>
	): Promise<QueryResult<R>>;
}

export type Queryable = QueryableObject | Promise<QueryableObject>;