Skip to content

Commit dd191ce

Browse files
committed
Added type declarations for Prepare and PrepareStatementInfo
1 parent dbb344e commit dd191ce

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
import Sequence = require('mysql2/typings/mysql/lib/protocol/sequences/Sequence');
2+
import Query = require('mysql2/typings/mysql/lib/protocol/sequences/Query');
3+
import {OkPacket, FieldPacket, RowDataPacket, ResultSetHeader} from 'mysql2/typings/mysql/lib/protocol/packets';
4+
import {Readable} from 'stream';
5+
6+
declare namespace Prepare {
7+
export class PrepareStatementInfo {
8+
close(): void;
9+
execute<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(
10+
paramaters: any | any[] | { [param: string]: any },
11+
callback?: (
12+
err: Query.QueryError | null,
13+
result: T,
14+
fields: FieldPacket[]
15+
) => any): Query;
16+
}
17+
}
18+
19+
declare class Prepare extends Sequence {
20+
/**
21+
* The SQL for a constructed query
22+
*/
23+
sql: string;
24+
25+
/**
26+
* Emits a query packet to start the query
27+
*/
28+
start(): void;
29+
30+
/**
31+
* Determines the packet class to use given the first byte of the packet.
32+
*
33+
* @param firstByte The first byte of the packet
34+
* @param parser The packet parser
35+
*/
36+
determinePacket(firstByte: number, parser: any): any;
37+
38+
/**
39+
* Creates a Readable stream with the given options
40+
*
41+
* @param options The options for the stream.
42+
*/
43+
stream(options?: Query.StreamOptions): Readable;
44+
45+
on(event: string, listener: Function): this;
46+
on(event: 'error', listener: (err: Query.QueryError) => any): this;
47+
on(event: 'fields', listener: (fields: FieldPacket, index: number) => any): this;
48+
on(event: 'result', listener: (result: RowDataPacket | OkPacket, index: number) => any): this;
49+
on(event: 'end', listener: () => any): this;
50+
}
51+
52+
export = Prepare;

0 commit comments

Comments
 (0)