Skip to content
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

Jump to bottom

refactor: unifies spread types in their proper places #2067

Closed
wants to merge 6 commits into from
Closed

refactor: unifies spread types in their proper places #2067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
71a480f
refactor: remove older type tests
wellwelwel Jun 14, 2023
7349990
refactor: redefine TypeScript settings
wellwelwel Jun 15, 2023
87ac5b4
refactor: unify types
wellwelwel Jun 15, 2023
8203d68
refactor: increment `NodeNext` TypeScript compatibility
wellwelwel Jun 15, 2023
775e379
refactor: patterning `PrepareStatementInfo`
wellwelwel Jun 15, 2023
6a6e82a
refactor: `pool` `maxIdle` description
wellwelwel Jun 16, 2023
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
26 changes: 17 additions & 9 deletions .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": ["prettier", "eslint:recommended", "plugin:markdown/recommended"],
"extends": ["prettier", "eslint:recommended", "plugin:markdown/recommended"],
"parserOptions": {
"ecmaVersion": 2022
"ecmaVersion": "latest"
},
"plugins": ["markdown", "async-await"],
"env": {
Expand Down Expand Up @@ -39,16 +39,24 @@
},
"overrides": [
{
"files": ["**/*.ts"],
"files": ["**/*.ts"],
"parser": "@typescript-eslint/parser",
"extends": [
"plugin:@typescript-eslint/recommended",
"prettier"
],
"plugins": ["@typescript-eslint"]
"extends": ["plugin:@typescript-eslint/recommended", "prettier"],
"plugins": ["@typescript-eslint"],
"rules": {
"@typescript-eslint/no-empty-interface": "off",
"@typescript-eslint/no-explicit-any": "off",
"no-restricted-syntax": [
"error",
{
"selector": "ImportDeclaration[source.value=/^\\./][source.value!=/\\.(js)$/]",
"message": "Local imports must have the explicit extension"
}
]
}
},
{
"files": ["**/*.md/*js"],
"files": ["**/*.md/*js"],
"rules": {
"no-undef": "off",
"no-unused-vars": "off",
Expand Down
206 changes: 1 addition & 205 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,205 +1 @@
import {
Connection as PromiseConnection,
Pool as PromisePool,
PoolConnection as PromisePoolConnection,
} from './promise';

import * as mysql from './typings/mysql';
export * from './typings/mysql';

export interface Connection extends mysql.Connection {
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
sql: string,
callback?: (
err: mysql.QueryError | null,
result: T,
fields: mysql.FieldPacket[]
) => any
): mysql.Query;
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
sql: string,
values: any | any[] | { [param: string]: any },
callback?: (
err: mysql.QueryError | null,
result: T,
fields: mysql.FieldPacket[]
) => any
): mysql.Query;
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
options: mysql.QueryOptions,
callback?: (
err: mysql.QueryError | null,
result: T,
fields?: mysql.FieldPacket[]
) => any
): mysql.Query;
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
options: mysql.QueryOptions,
values: any | any[] | { [param: string]: any },
callback?: (
err: mysql.QueryError | null,
result: T,
fields: mysql.FieldPacket[]
) => any
): mysql.Query;
ping(callback?: (err: mysql.QueryError | null) => any): void;
unprepare(sql: string): mysql.PrepareStatementInfo;
prepare(sql: string, callback?: (err: mysql.QueryError | null, statement: mysql.PrepareStatementInfo) => any): mysql.Prepare;
serverHandshake(args: any): any;
writeOk(args?: mysql.OkPacketParams): void;
writeError(args?: mysql.ErrorPacketParams): void;
writeEof(warnings?: number, statusFlags?: number): void;
writeTextResult(rows?: Array<any>, columns?: Array<any>): void;
writePacket(packet: any): void;
promise(promiseImpl?: PromiseConstructor): PromiseConnection;
sequenceId: number;
}

export interface PoolConnection extends mysql.PoolConnection {
promise(promiseImpl?: PromiseConstructor): PromisePool;
}

export interface Pool extends mysql.Connection {
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
sql: string,
callback?: (
err: mysql.QueryError | null,
result: T,
fields: mysql.FieldPacket[]
) => any
): mysql.Query;
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
sql: string,
values: any | any[] | { [param: string]: any },
callback?: (
err: mysql.QueryError | null,
result: T,
fields: mysql.FieldPacket[]
) => any
): mysql.Query;
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
options: mysql.QueryOptions,
callback?: (
err: mysql.QueryError | null,
result: T,
fields?: mysql.FieldPacket[]
) => any
): mysql.Query;
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
| mysql.ResultSetHeader
>(
options: mysql.QueryOptions,
values: any | any[] | { [param: string]: any },
callback?: (
err: mysql.QueryError | null,
result: T,
fields: mysql.FieldPacket[]
) => any
): mysql.Query;
getConnection(
callback: (err: NodeJS.ErrnoException, connection: PoolConnection) => any
): void;
releaseConnection(connection: PoolConnection | PromisePoolConnection): void;
on(event: 'connection', listener: (connection: PoolConnection) => any): this;
on(event: 'acquire', listener: (connection: PoolConnection) => any): this;
on(event: 'release', listener: (connection: PoolConnection) => any): this;
on(event: 'enqueue', listener: () => any): this;
unprepare(sql: string): mysql.PrepareStatementInfo;
prepare(sql: string, callback?: (err: mysql.QueryError | null, statement: mysql.PrepareStatementInfo) => any): mysql.Prepare;
promise(promiseImpl?: PromiseConstructor): PromisePool;
config: mysql.PoolOptions;
}

export interface ConnectionOptions extends mysql.ConnectionOptions {
charsetNumber?: number;
compress?: boolean;
authSwitchHandler?: (data: any, callback: () => void) => any;
connectAttributes?: { [param: string]: any };
decimalNumbers?: boolean;
isServer?: boolean;
maxPreparedStatements?: number;
namedPlaceholders?: boolean;
nestTables?: boolean | string;
passwordSha1?: string;
pool?: any;
rowsAsArray?: boolean;
stream?: any;
uri?: string;
connectionLimit?: number;
maxIdle?: number;
idleTimeout?: number;
Promise?: any;
queueLimit?: number;
waitForConnections?: boolean;
authPlugins?: {
[key: string]: mysql.AuthPlugin;
};
}

export interface ConnectionConfig extends ConnectionOptions {
mergeFlags(defaultFlags: string[], userFlags: string[] | string): number;
getDefaultFlags(options?: ConnectionOptions): string[];
getCharsetNumber(charset: string): number;
getSSLProfile(name: string): { ca: string[] };
parseUrl(url: string): { host: string, port: number, database: string, user: string, password: string, [key: string]: any };
}

export interface PoolOptions extends mysql.PoolOptions, ConnectionOptions {}

export function createConnection(connectionUri: string): Connection;
export function createConnection(config: ConnectionOptions): Connection;
export function createPool(config: PoolOptions): Pool;
export * from './typings/mysql/index.js';
Loading
Loading