Skip to content

Commit 5513c70

Browse files
nikelbormnikelborm
authored
refactor(types): squash query results types into QueryResult (#2462)
* typo: procotol41 > protocol41 * refactor: removed duplication of result type * refactor: better naming (ExecuteOrQueryResultPackets -> QueryResult)
1 parent feeb257 commit 5513c70

File tree

7 files changed

+31
-178
lines changed

7 files changed

+31
-178
lines changed

‎test/tsc-build/helpers.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export const isOkPacket = (
3030
'serverStatus',
3131
'warningCount',
3232
'message',
33-
'procotol41',
33+
'protocol41',
3434
];
3535

3636
return keys.every((key) => key in data);

‎typings/mysql/lib/protocol/packets/OkPacket.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ declare interface OkPacket {
1717
serverStatus: number;
1818
warningCount: number;
1919
message: string;
20-
procotol41: boolean;
20+
protocol41: boolean;
2121
}
2222

2323
export { OkPacket };

‎typings/mysql/lib/protocol/packets/index.d.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ import { ResultSetHeader } from './ResultSetHeader.js';
77
import { OkPacketParams } from './params/OkPacketParams.js';
88
import { ErrorPacketParams } from './params/ErrorPacketParams.js';
99

10+
export type QueryResult =
11+
| OkPacket
12+
| ResultSetHeader
13+
| ResultSetHeader[]
14+
| RowDataPacket[]
15+
| RowDataPacket[][]
16+
| OkPacket[]
17+
| ProcedureCallPacket;
18+
1019
export {
1120
OkPacket,
1221
RowDataPacket,

‎typings/mysql/lib/protocol/sequences/ExecutableBase.d.ts

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
import {
2-
OkPacket,
32
FieldPacket,
4-
RowDataPacket,
5-
ResultSetHeader,
6-
ProcedureCallPacket,
3+
QueryResult,
74
} from '../packets/index.js';
85
import {
96
Query,
@@ -16,62 +13,26 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
1613
Base?: T
1714
): {
1815
new (...args: any[]): {
19-
execute<
20-
T extends
21-
| OkPacket
22-
| ResultSetHeader
23-
| ResultSetHeader[]
24-
| RowDataPacket[]
25-
| RowDataPacket[][]
26-
| OkPacket[]
27-
| ProcedureCallPacket
28-
>(
16+
execute<T extends QueryResult>(
2917
sql: string,
3018
callback?:
3119
| ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
3220
| undefined
3321
): Query;
34-
execute<
35-
T extends
36-
| OkPacket
37-
| ResultSetHeader
38-
| ResultSetHeader[]
39-
| RowDataPacket[]
40-
| RowDataPacket[][]
41-
| OkPacket[]
42-
| ProcedureCallPacket
43-
>(
22+
execute<T extends QueryResult>(
4423
sql: string,
4524
values: any,
4625
callback?:
4726
| ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
4827
| undefined
4928
): Query;
50-
execute<
51-
T extends
52-
| OkPacket
53-
| ResultSetHeader
54-
| ResultSetHeader[]
55-
| RowDataPacket[]
56-
| RowDataPacket[][]
57-
| OkPacket[]
58-
| ProcedureCallPacket
59-
>(
29+
execute<T extends QueryResult>(
6030
options: QueryOptions,
6131
callback?:
6232
| ((err: QueryError | null, result: T, fields?: FieldPacket[]) => any)
6333
| undefined
6434
): Query;
65-
execute<
66-
T extends
67-
| OkPacket
68-
| ResultSetHeader
69-
| ResultSetHeader[]
70-
| RowDataPacket[]
71-
| RowDataPacket[][]
72-
| OkPacket[]
73-
| ProcedureCallPacket
74-
>(
35+
execute<T extends QueryResult>(
7536
options: QueryOptions,
7637
values: any,
7738
callback?:

‎typings/mysql/lib/protocol/sequences/QueryableBase.d.ts

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
import {
2-
OkPacket,
32
FieldPacket,
4-
RowDataPacket,
5-
ResultSetHeader,
6-
ProcedureCallPacket,
3+
QueryResult,
74
} from '../packets/index.js';
85
import {
96
Query,
@@ -16,62 +13,26 @@ export declare function QueryableBase<T extends QueryableConstructor>(
1613
Base?: T
1714
): {
1815
new (...args: any[]): {
19-
query<
20-
T extends
21-
| OkPacket
22-
| ResultSetHeader
23-
| ResultSetHeader[]
24-
| RowDataPacket[]
25-
| RowDataPacket[][]
26-
| OkPacket[]
27-
| ProcedureCallPacket
28-
>(
16+
query<T extends QueryResult>(
2917
sql: string,
3018
callback?:
3119
| ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
3220
| undefined
3321
): Query;
34-
query<
35-
T extends
36-
| OkPacket
37-
| ResultSetHeader
38-
| ResultSetHeader[]
39-
| RowDataPacket[]
40-
| RowDataPacket[][]
41-
| OkPacket[]
42-
| ProcedureCallPacket
43-
>(
22+
query<T extends QueryResult>(
4423
sql: string,
4524
values: any,
4625
callback?:
4726
| ((err: QueryError | null, result: T, fields: FieldPacket[]) => any)
4827
| undefined
4928
): Query;
50-
query<
51-
T extends
52-
| OkPacket
53-
| ResultSetHeader
54-
| ResultSetHeader[]
55-
| RowDataPacket[]
56-
| RowDataPacket[][]
57-
| OkPacket[]
58-
| ProcedureCallPacket
59-
>(
29+
query<T extends QueryResult>(
6030
options: QueryOptions,
6131
callback?:
6232
| ((err: QueryError | null, result: T, fields?: FieldPacket[]) => any)
6333
| undefined
6434
): Query;
65-
query<
66-
T extends
67-
| OkPacket
68-
| ResultSetHeader
69-
| ResultSetHeader[]
70-
| RowDataPacket[]
71-
| RowDataPacket[][]
72-
| OkPacket[]
73-
| ProcedureCallPacket
74-
>(
35+
query<T extends QueryResult>(
7536
options: QueryOptions,
7637
values: any,
7738
callback?:

‎typings/mysql/lib/protocol/sequences/promise/ExecutableBase.d.ts

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,24 @@
11
import {
2-
OkPacket,
32
FieldPacket,
4-
RowDataPacket,
5-
ResultSetHeader,
6-
ProcedureCallPacket,
3+
QueryResult,
74
} from '../../packets/index.js';
85
import { QueryOptions, QueryableConstructor } from '../Query.js';
96

107
export declare function ExecutableBase<T extends QueryableConstructor>(
118
Base?: T
129
): {
1310
new (...args: any[]): {
14-
execute<
15-
T extends
16-
| OkPacket
17-
| ResultSetHeader
18-
| ResultSetHeader[]
19-
| RowDataPacket[]
20-
| RowDataPacket[][]
21-
| OkPacket[]
22-
| ProcedureCallPacket
23-
>(
11+
execute<T extends QueryResult>(
2412
sql: string
2513
): Promise<[T, FieldPacket[]]>;
26-
execute<
27-
T extends
28-
| OkPacket
29-
| ResultSetHeader
30-
| ResultSetHeader[]
31-
| RowDataPacket[]
32-
| RowDataPacket[][]
33-
| OkPacket[]
34-
| ProcedureCallPacket
35-
>(
14+
execute<T extends QueryResult>(
3615
sql: string,
3716
values: any
3817
): Promise<[T, FieldPacket[]]>;
39-
execute<
40-
T extends
41-
| OkPacket
42-
| ResultSetHeader
43-
| ResultSetHeader[]
44-
| RowDataPacket[]
45-
| RowDataPacket[][]
46-
| OkPacket[]
47-
| ProcedureCallPacket
48-
>(
18+
execute<T extends QueryResult>(
4919
options: QueryOptions
5020
): Promise<[T, FieldPacket[]]>;
51-
execute<
52-
T extends
53-
| OkPacket
54-
| ResultSetHeader
55-
| ResultSetHeader[]
56-
| RowDataPacket[]
57-
| RowDataPacket[][]
58-
| OkPacket[]
59-
| ProcedureCallPacket
60-
>(
21+
execute<T extends QueryResult>(
6122
options: QueryOptions,
6223
values: any
6324
): Promise<[T, FieldPacket[]]>;

‎typings/mysql/lib/protocol/sequences/promise/QueryableBase.d.ts

Lines changed: 5 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,24 @@
11
import {
2-
OkPacket,
32
FieldPacket,
4-
RowDataPacket,
5-
ResultSetHeader,
6-
ProcedureCallPacket,
3+
QueryResult,
74
} from '../../packets/index.js';
85
import { QueryOptions, QueryableConstructor } from '../Query.js';
96

107
export declare function QueryableBase<T extends QueryableConstructor>(
118
Base?: T
129
): {
1310
new (...args: any[]): {
14-
query<
15-
T extends
16-
| OkPacket
17-
| ResultSetHeader
18-
| ResultSetHeader[]
19-
| RowDataPacket[]
20-
| RowDataPacket[][]
21-
| OkPacket[]
22-
| ProcedureCallPacket
23-
>(
11+
query<T extends QueryResult>(
2412
sql: string
2513
): Promise<[T, FieldPacket[]]>;
26-
query<
27-
T extends
28-
| OkPacket
29-
| ResultSetHeader
30-
| ResultSetHeader[]
31-
| RowDataPacket[]
32-
| RowDataPacket[][]
33-
| OkPacket[]
34-
| ProcedureCallPacket
35-
>(
14+
query<T extends QueryResult>(
3615
sql: string,
3716
values: any
3817
): Promise<[T, FieldPacket[]]>;
39-
query<
40-
T extends
41-
| OkPacket
42-
| ResultSetHeader
43-
| ResultSetHeader[]
44-
| RowDataPacket[]
45-
| RowDataPacket[][]
46-
| OkPacket[]
47-
| ProcedureCallPacket
48-
>(
18+
query<T extends QueryResult>(
4919
options: QueryOptions
5020
): Promise<[T, FieldPacket[]]>;
51-
query<
52-
T extends
53-
| OkPacket
54-
| ResultSetHeader
55-
| ResultSetHeader[]
56-
| RowDataPacket[]
57-
| RowDataPacket[][]
58-
| OkPacket[]
59-
| ProcedureCallPacket
60-
>(
21+
query<T extends QueryResult>(
6122
options: QueryOptions,
6223
values: any
6324
): Promise<[T, FieldPacket[]]>;

0 commit comments

Comments
 (0)