Create a project in the examples folder and move all the needed files in there

Export the FieldInfo and the Query from the index.d.ts
Update the example's Readme

Author: Michael Kornelakis

examples/README.md

@@ -8,10 +8,10 @@ To run a docker container with this data and bound to the correct port, you can
 docker run -p 3306:3306 --name mysql_container -e MYSQL_ROOT_PASSWORD=password -d genschsa/mysql-employees
 ```
 
-### Typecript
+### Typescript
 
-In the `typescript` folder there are the equivalent examples. In order to run them you can use `npm run ts-node` followed by the path of the file. So for example you can run `npm run ts-node ./examples/connection/typescript/query`
+In the `typescript` folder there is a sample project with the examples that demostrate how this library would be used in a typescript project. In order to run them you need to navigate in the project's folder and then install the npm packages with `npm install` and then you can use `npm run ts-node` followed by the name of the file. So for example you can run `npm run ts-node .src/query.ts`
 
 ### Note
 
-These examples are using `ts-node` in order to avoid including a bundler. If you try to compile the typescript files to javascript using ithe `outDir` option in `tsconfig` then you will get import errors beacuse we are pulling the `index` file form the root of the project.
+These examples are using `ts-node` in order to avoid including a bundler. If you try to compile the typescript files to javascript using the `outDir` option in `tsconfig` then you will get import errors because we are pulling the `index` file form the root.

examples/connection/typescript/package-lock.json

@@ -0,0 +1,18 @@
+{
+  "name": "typescript-promisify-mysql",
+  "version": "1.0.0",
+  "description": "A demo to show how one would use promisify-mysql withing a typescript project",
+  "scripts": {
+    "ts-node": "ts-node"
+  },
+  "author": "Michael Kornelakis",
+  "license": "MIT",
+  "devDependencies": {
+    "mysql": "^2.18.1",
+    "@types/mysql": "^2.15.2",
+    "@types/bluebird": "^3.5.26",
+    "bluebird": "^3.5.1",
+    "ts-node": "^10.7.0",
+    "typescript": "^4.6.3"
+  }
+}

examples/connection/typescript/package.json

@@ -1,5 +1,5 @@
 import Bluebird from 'bluebird';
-import * as mysql from '../../../index';
+import * as mysql from '../../../../index';
 
 async function runReturn() {
     const connection = await mysql.createConnection({

…amples/connection/typescript/employee.ts …es/connection/typescript/src/employee.tsexamples/connection/typescript/employee.ts renamed to examples/connection/typescript/src/employee.ts examples/connection/typescript/employee.ts renamed to examples/connection/typescript/src/employee.ts

@@ -1,4 +1,4 @@
-import * as mysql from '../../../index';
+import * as mysql from '../../../../index';
 import { Employee } from './employee';
 
 async function run() {
@@ -16,7 +16,7 @@ async function run() {
         employees.forEach(employee => {
             console.log(`The employee with the employee number ${employee.emp_no} is ${employee.first_name} ${employee.last_name}`);
         });
-    
+
         connection.end();
     })
 }

…es/connection/typescript/mysqlWrapper.ts …onnection/typescript/src/mysqlWrapper.tsexamples/connection/typescript/mysqlWrapper.ts renamed to examples/connection/typescript/src/mysqlWrapper.ts examples/connection/typescript/mysqlWrapper.ts renamed to examples/connection/typescript/src/mysqlWrapper.ts

@@ -1,4 +1,4 @@
-import * as mysql from '../../../index';
+import * as mysql from '../../../../index';
 import { Employee } from './employee';
 
 function run() {

examples/connection/typescript/query.ts …mples/connection/typescript/src/query.tsexamples/connection/typescript/query.ts renamed to examples/connection/typescript/src/query.ts examples/connection/typescript/query.ts renamed to examples/connection/typescript/src/query.ts

@@ -1,4 +1,5 @@
-import mysql from '../../../index';
+import mysql from '../../../../index';
+import type { FieldInfo, Query } from '../../../../index';
 import { Employee } from './employee';
 
 function run() {
@@ -12,7 +13,7 @@ function run() {
     }).then((conn) => {
         connection = conn;
 
-        return connection.query<[data: Employee[], fields: mysql.FieldInfo[], query: mysql.Query]>('select * from employees limit 0, 10');
+        return connection.query<[data: Employee[], fields: FieldInfo[], query: Query<Employee>]>('select * from employees limit 0, 10');
     }).then(([data, fields, query]) => {
         console.log(`The SQL for the query was: ${query.sql}\n`);
 
@@ -39,7 +40,7 @@ async function runAwait() {
         returnArgumentsArray: true
     });
 
-    const [data, fields, query] = await connection.query<[data: Employee[], fields: mysql.FieldInfo[], query: mysql.Query]>('select * from employees limit 0, 10');
+    const [data, fields, query] = await connection.query<[data: Employee[], fields: mysql.FieldInfo[], query: Query<Employee>]>('select * from employees limit 0, 10');
 
     console.log(`The SQL for the query was: ${query.sql}\n`);
 

…les/connection/typescript/querystream.ts …connection/typescript/src/querystream.tsexamples/connection/typescript/querystream.ts renamed to examples/connection/typescript/src/querystream.ts examples/connection/typescript/querystream.ts renamed to examples/connection/typescript/src/querystream.ts

@@ -1,6 +1,8 @@
 import * as mysql from 'mysql';
 import * as Bluebird from 'bluebird';
 
+export type { FieldInfo } from 'mysql';
+
 export function createConnection(connectionUri: string | ConnectionConfig): Bluebird<Connection>;
 
 export function createPool(config: PoolConfig | string): Bluebird<Pool>;
@@ -10,9 +12,6 @@ export function createPoolCluster(config: mysql.PoolClusterConfig): Bluebird<Poo
 export { Types, escape, escapeId, format, raw, ConnectionOptions, PoolClusterConfig, MysqlError } from 'mysql';
 
 export type mysqlModule = typeof mysql;
-export type FieldInfo = typeof mysql.FieldInfo;
-export type Query = typeof mysql.Query;
-
 export interface ConnectionConfig extends mysql.ConnectionConfig {
     mysqlWrapper?: (mysql: mysqlModule, callback?: (err: Error | null, success?: mysqlModule) => void) => mysqlModule | Promise<mysqlModule> | void;
     returnArgumentsArray?: boolean;
@@ -26,9 +25,9 @@ export interface PoolConfig extends mysql.PoolConfig {
 }
 
 export interface QueryFunction {
-    <T extends unknown>(query: mysql.Query | string | mysql.QueryOptions): T;
+    <T extends unknown>(query: mysql.Query | string | mysql.QueryOptions): Bluebird<T>;
 
-    <T extends unknown>(options: string, values?: any): T;
+    <T extends unknown>(options: string, values?: any): Bluebird<T>;
 }
 
 export interface Query<T> extends mysql.Query {