Skip to content

fix: types for query values #3985

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
uPaymeiFixit wants to merge 1 commit into
base: master
Choose a base branch
from
+15 −4
Open

fix: types for query values #3985

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion typings/mysql/lib/protocol/sequences/Query.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@ import { OkPacket, RowDataPacket, FieldPacket } from '../packets/index.js';
import { Readable } from 'stream';
import { TypeCast } from '../../parsers/typeCast.js';

export type QueryValues =
| string
| number
| bigint
| boolean
| Date
| null
| Blob
| Buffer
| ({} | null)[];

export interface QueryOptions {
/**
* The SQL for the query
Expand All @@ -12,7 +23,7 @@ export interface QueryOptions {
/**
* The values for the query
*/
values?: any | any[] | { [param: string]: any };
values?: QueryValues;

/**
* This overrides the namedPlaceholders option set at the connection level.
Expand Down
6 changes: 3 additions & 3 deletions typings/mysql/lib/protocol/sequences/promise/ExecutableBase.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { FieldPacket, QueryResult } from '../../packets/index.js';
import { QueryOptions, QueryableConstructor } from '../Query.js';
import { QueryOptions, QueryableConstructor, QueryValues } from '../Query.js';

export declare function ExecutableBase<T extends QueryableConstructor>(
Base?: T
Expand All @@ -8,14 +8,14 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
execute<T extends QueryResult>(sql: string): Promise<[T, FieldPacket[]]>;
execute<T extends QueryResult>(
sql: string,
values: any
values: QueryValues
): Promise<[T, FieldPacket[]]>;
execute<T extends QueryResult>(
options: QueryOptions
): Promise<[T, FieldPacket[]]>;
execute<T extends QueryResult>(
options: QueryOptions,
values: any
values: QueryValues
): Promise<[T, FieldPacket[]]>;
};
} & T;
Loading