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

Add typescript types #1028

Closed
wants to merge 1 commit into from
Closed

Add typescript types #1028

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
14 changes: 13 additions & 1 deletion .eslintrc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,17 @@
"no-var": "error",
"no-use-before-define": "error",
"strict": ["error", "global"]
}
},
"overrides": [
{
"files": ["**/*.ts"],
"parser": "@typescript-eslint/parser",
"extends": [
"plugin:@typescript-eslint/recommended",
"prettier",
"prettier/@typescript-eslint"
],
"plugins": ["@typescript-eslint"]
}
]
}
171 changes: 171 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
import {
Connection as PromiseConnection,
Pool as PromisePool,
PoolConnection as PromisePoolConnection
} from './promise';

import * as mysql from 'mysql';
export * from 'mysql';

export interface Connection extends mysql.Connection {
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
>(
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[]
>(
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[]
>(
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[]
>(
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;
promise(promiseImpl?: PromiseConstructor): PromiseConnection;
}

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

export interface Pool extends mysql.Connection {
execute<
T extends
| mysql.RowDataPacket[][]
| mysql.RowDataPacket[]
| mysql.OkPacket
| mysql.OkPacket[]
>(
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[]
>(
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[]
>(
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[]
>(
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;
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;
promise(promiseImpl?: PromiseConstructor): PromisePool;
}

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;
Promise?: any;
queueLimit?: number;
waitForConnections?: boolean;
}

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;
92 changes: 90 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"author": "Andrey Sidorov <[email protected]>",
"license": "MIT",
"dependencies": {
"@types/mysql": "^2.15.7",
"cardinal": "^2.1.1",
"denque": "^1.4.1",
"generate-function": "^2.3.1",
Expand All @@ -56,6 +57,8 @@
"sqlstring": "^2.3.1"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^2.3.2",
"@typescript-eslint/parser": "^2.3.2",
"assert-diff": "^2.0.2",
"error-stack-parser": "^2.0.3",
"eslint": "^6.2.2",
Expand All @@ -69,6 +72,7 @@
"prettier": "^1.18.2",
"prettier-markdown": "^0.1.6",
"progress": "^2.0.3",
"typescript": "^3.6.3",
"urun": "0.0.8",
"utest": "0.0.8"
}
Expand Down
Loading