datasquirel/dist/package-shared/functions/api/query-dsql-api.d.ts
Benjamin Toby 700a704abd Updates
2025-08-13 11:16:28 +01:00

24 lines
818 B
TypeScript

import { APIConnectionOptions, APIResponseObject, DataCrudRequestMethods, DataCrudRequestMethodsLowerCase } from "../../types";
import { GrabHostNamesReturn } from "../../utils/grab-host-names";
type Param<T = {
[k: string]: any;
}> = {
body?: T;
query?: T;
useDefault?: boolean;
path: string;
method?: (typeof DataCrudRequestMethods)[number] | (typeof DataCrudRequestMethodsLowerCase)[number];
apiKey?: string;
apiConnectionConfig?: APIConnectionOptions;
grabbedHostnames?: GrabHostNamesReturn;
};
/**
* # Query DSQL API
*/
export default function queryDSQLAPI<T = {
[k: string]: any;
}, P = {
[k: string]: any;
}>({ body, query, useDefault, path: passedPath, method, apiKey, apiConnectionConfig, grabbedHostnames, }: Param<T>): Promise<APIResponseObject<P>>;
export {};