aboutsummaryrefslogtreecommitdiff
path: root/node_modules/mysql2/typings/mysql/lib/Pool.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/mysql2/typings/mysql/lib/Pool.d.ts')
-rw-r--r--node_modules/mysql2/typings/mysql/lib/Pool.d.ts65
1 files changed, 65 insertions, 0 deletions
diff --git a/node_modules/mysql2/typings/mysql/lib/Pool.d.ts b/node_modules/mysql2/typings/mysql/lib/Pool.d.ts
new file mode 100644
index 0000000..ebfb7a5
--- /dev/null
+++ b/node_modules/mysql2/typings/mysql/lib/Pool.d.ts
@@ -0,0 +1,65 @@
+
+import Query = require('./protocol/sequences/Query');
+import {OkPacket, RowDataPacket, FieldPacket, ResultSetHeader} from './protocol/packets/index';
+import Connection = require('./Connection');
+import PoolConnection = require('./PoolConnection');
+import {EventEmitter} from 'events';
+
+declare namespace Pool {
+
+ export interface PoolOptions extends Connection.ConnectionOptions {
+ /**
+ * The milliseconds before a timeout occurs during the connection acquisition. This is slightly different from connectTimeout,
+ * because acquiring a pool connection does not always involve making a connection. (Default: 10 seconds)
+ */
+ acquireTimeout?: number;
+
+ /**
+ * Determines the pool's action when no connections are available and the limit has been reached. If true, the pool will queue
+ * the connection request and call it when one becomes available. If false, the pool will immediately call back with an error.
+ * (Default: true)
+ */
+ waitForConnections?: boolean;
+
+ /**
+ * The maximum number of connections to create at once. (Default: 10)
+ */
+ connectionLimit?: number;
+
+ /**
+ * The maximum number of connection requests the pool will queue before returning an error from getConnection. If set to 0, there
+ * is no limit to the number of queued connection requests. (Default: 0)
+ */
+ queueLimit?: number;
+
+ /**
+ * Enable keep-alive on the socket. It's disabled by default, but the
+ * user can enable it and supply an initial delay.
+ */
+ enableKeepAlive?: true;
+
+ /**
+ * If keep-alive is enabled users can supply an initial delay.
+ */
+ keepAliveInitialDelay?: number;
+ }
+}
+
+declare class Pool extends EventEmitter {
+
+ config: Pool.PoolOptions;
+
+ getConnection(callback: (err: NodeJS.ErrnoException, connection: PoolConnection) => any): void;
+
+ query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(sql: string, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
+ query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(sql: string, values: any | any[] | { [param: string]: any }, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
+ query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(options: Query.QueryOptions, callback?: (err: Query.QueryError | null, result: T, fields?: FieldPacket[]) => any): Query;
+ query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(options: Query.QueryOptions, values: any | any[] | { [param: string]: any }, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
+
+ end(callback?: (err: NodeJS.ErrnoException | null, ...args: any[]) => any): void;
+
+ on(event: string, listener: Function): this;
+ on(event: 'connection', listener: (connection: PoolConnection) => any): this;
+}
+
+export = Pool;