index.d.ts 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. import { Pool as BasePool, PoolOptions } from './lib/Pool.js';
  2. import {
  3. Connection as BaseConnection,
  4. ConnectionOptions,
  5. SslOptions,
  6. } from './lib/Connection.js';
  7. import {
  8. Query as BaseQuery,
  9. QueryOptions,
  10. QueryError,
  11. } from './lib/protocol/sequences/Query.js';
  12. import {
  13. PoolCluster as BasePoolCluster,
  14. PoolClusterOptions,
  15. PoolNamespace,
  16. } from './lib/PoolCluster.js';
  17. import { PoolConnection as BasePoolConnection } from './lib/PoolConnection.js';
  18. import {
  19. Prepare as BasePrepare,
  20. PrepareStatementInfo,
  21. } from './lib/protocol/sequences/Prepare.js';
  22. import { Server } from './lib/Server.js';
  23. import {
  24. escape as SqlStringEscape,
  25. escapeId as SqlStringEscapeId,
  26. format as SqlStringFormat,
  27. raw as SqlStringRaw,
  28. } from 'sql-escaper';
  29. export type { Raw, SqlValue, Timezone } from 'sql-escaper';
  30. export {
  31. ConnectionOptions,
  32. SslOptions,
  33. PoolOptions,
  34. PoolClusterOptions,
  35. PoolNamespace,
  36. QueryOptions,
  37. QueryError,
  38. PrepareStatementInfo,
  39. };
  40. export * from './lib/protocol/packets/index.js';
  41. export * from './lib/Auth.js';
  42. export * from './lib/constants/index.js';
  43. export * from './lib/parsers/index.js';
  44. export * from './lib/Connection.js';
  45. // Expose class interfaces
  46. export interface Connection extends BaseConnection {}
  47. export interface Pool extends BasePool {}
  48. export interface PoolConnection extends BasePoolConnection {}
  49. export interface PoolCluster extends BasePoolCluster {}
  50. export interface Query extends BaseQuery {}
  51. export interface Prepare extends BasePrepare {}
  52. export function createConnection(connectionUri: string): BaseConnection;
  53. export function createConnection(config: ConnectionOptions): BaseConnection;
  54. export function createPool(connectionUri: string): BasePool;
  55. export function createPool(config: PoolOptions): BasePool;
  56. export function createPoolCluster(config?: PoolClusterOptions): PoolCluster;
  57. export const escape: typeof SqlStringEscape;
  58. export const escapeId: typeof SqlStringEscapeId;
  59. export const format: typeof SqlStringFormat;
  60. export const raw: typeof SqlStringRaw;
  61. export interface ConnectionConfig extends ConnectionOptions {
  62. mergeFlags(defaultFlags: string[], userFlags: string[] | string): number;
  63. getDefaultFlags(options?: ConnectionOptions): string[];
  64. getCharsetNumber(charset: string): number;
  65. getSSLProfile(name: string): { ca: string[] };
  66. parseUrl(url: string): {
  67. host: string;
  68. port: number;
  69. database: string;
  70. user: string;
  71. password: string;
  72. [key: string]: any;
  73. };
  74. }
  75. export function createServer(handler: (conn: BaseConnection) => any): Server;