datasquirel/dist/package-shared/utils/db/conn-db-handler.d.ts
Benjamin Toby 6acf0f2cd6 Updates
2025-07-06 17:00:35 +01:00

31 lines
921 B
TypeScript

import { DSQLErrorObject } from "../../types";
import mariadb, { ConnectionConfig } from "mariadb";
export type ConnDBHandlerQueryObject = {
query: string;
values?: (string | number | undefined)[];
};
type Return<ReturnType = any> = ReturnType | ReturnType[] | null | {
error?: string;
errors?: DSQLErrorObject[];
config?: ConnectionConfig;
};
/**
* # Run Query From MySQL Connection
* @description Run a query from a pre-existing MySQL/Mariadb Connection
* setup with `serverless-mysql` npm module
*/
export default function connDbHandler<ReturnType = any>(
/**
* MariaDB Connection
*/
conn?: mariadb.Connection,
/**
* String Or `ConnDBHandlerQueryObject` Array
*/
query?: ConnDBHandlerQueryObject["query"] | ConnDBHandlerQueryObject[],
/**
* Array of Values to Sanitize and Inject
*/
values?: ConnDBHandlerQueryObject["values"], debug?: boolean): Promise<Return<ReturnType>>;
export {};