fix(typings): synchronize types of sqlstring (#3047)

* fix: Export types directly from sqlstring dependency Signed-off-by: Scraps <[email protected]> * Revert "fix: Export types directly from sqlstring dependency" This reverts commit f489a97. * refactor: Merged similarly shaped format overloads Signed-off-by: Scraps <[email protected]> * fix: Added "hidden" type definitions provided by sqlstring package Signed-off-by: Scraps <[email protected]> * Added header comments Signed-off-by: Scraps <[email protected]> * refactor: moved header comment Signed-off-by: Scraps <[email protected]> * refactor: typing corrections Signed-off-by: Scraps <[email protected]> * fix: Ran prettier Signed-off-by: Scraps <[email protected]> --------- Signed-off-by: Scraps <[email protected]>
sidorares · Sep 14, 2024 · 81be01b · 81be01b
1 parent 3d2327d
commit 81be01b
Showing 1 changed file with 12 additions and 11 deletions.
diff --git a/typings/mysql/index.d.ts b/typings/mysql/index.d.ts
@@ -1,3 +1,6 @@
+/**
+ * sqlstring types are based on https://www.npmjs.com/package/@types/sqlstring, version 2.3.2
+ */
 import { Pool as BasePool, PoolOptions } from './lib/Pool.js';
 import {
   Connection as BaseConnection,
@@ -53,23 +56,21 @@ export function createPool(config: PoolOptions): BasePool;
 
 export function createPoolCluster(config?: PoolClusterOptions): PoolCluster;
 
-export function escape(value: any): string;
-
-export function escapeId(value: any): string;
-
-export function format(sql: string): string;
-export function format(
-  sql: string,
-  values: any[],
+type TimeZone = 'local' | 'Z' | (string & NonNullable<unknown>);
+export function escape(
+  value: any,
   stringifyObjects?: boolean,
-  timeZone?: string,
+  timeZone?: TimeZone,
 ): string;
 
+export function escapeId(value: any, forbidQualified?: boolean): string;
+
+export function format(sql: string): string;
 export function format(
   sql: string,
-  values: any,
+  values: any | any[],
   stringifyObjects?: boolean,
-  timeZone?: string,
+  timeZone?: TimeZone,
 ): string;
 
 export function raw(sql: string): {