type improvemnts and readme update

Author: Michael Kornelakis

examples/README.md

@@ -14,4 +14,4 @@ In the `typescript` folder there are the equivalent examples. In order to run th
 
 ### Note
 
-I am 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 ithe `outDir` option in `tsconfig` then you will get import errors beacuse we are pulling the `index` file form the root of the project.

examples/connection/typescript/returnArgumentsArray.ts

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

index.d.ts

@@ -10,6 +10,8 @@ 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;