docs: introduce TypeScript documentation

Author: wellwelwel

.eslintrc

@@ -57,10 +57,11 @@
       }
     },
     {
-      "files": ["**/*.md/*js"],
+      "files": ["**/*.md/*js", "**/*.md/*ts"],
       "rules": {
         "no-undef": "off",
         "no-unused-vars": "off",
+        "@typescript-eslint/no-unused-vars": "off",
         "no-console": "off",
         "no-unused-labels": "off",
         "strict": "off",

README.md

@@ -53,6 +53,14 @@ MySQL2 is free from native bindings and can be installed on Linux, Mac OS or Win
 npm install --save mysql2
 ```
 
+If you are using TypeScript, you will need to install `@types/node`.
+
+```bash
+npm install --save-dev @types/node
+```
+
+> For TypeScript documentation and examples, see [here](./documentation/en/TypeScript-Examples.md).
+
 ## First Query
 ```js
 // get the client

documentation/en/TypeScript-Examples.md

@@ -0,0 +1,157 @@
+# Using MySQL2 with TypeScript
+
+## Installation
+```bash
+npm install --save mysql2
+npm install --save-dev @types/node
+```
+
+> The `@types/node` ensure the proper interaction between **TypeScript** and the **Node.js** modules used by **MySQL2** (*net*, *events*, *stream*, *tls*, etc.).
+
+## Import
+You can import **MySQL2** in two ways:
+```ts
+import * as mysql from 'mysql2';
+import * as mysql from 'mysql2/promise';
+
+// By setting the `esModuleInterop` option to `true` in `tsconfig.json`
+import mysql from 'mysql2';
+import mysql from 'mysql2/promise';
+```
+
+## Connection
+```ts
+import mysql, { ConnectionOptions } from 'mysql2';
+
+const access: ConnectionOptions = {
+  user: 'test',
+  database: 'test',
+};
+
+const conn = mysql.createConnection(access);
+```
+
+## Pool Connection
+```ts
+import mysql, { PoolOptions } from 'mysql2';
+
+const access: PoolOptions = {
+  user: 'test',
+  database: 'test',
+};
+
+const conn = mysql.createPool(access);
+```
+
+## Query and Execute
+### A simple SELECT
+```ts
+conn.query('SELECT 1 + 1 AS `test`;', (_err, rows) => {
+  /**
+   * @rows: [ { test: 2 } ]
+   */
+});
+```
+
+The `rows` output will be these possible types:
+- `RowDataPacket[]`
+- `RowDataPacket[][]`
+- `ResultSetHeader`
+- `ProcedureCallPacket`
+- `OkPacket`
+- `OkPacket[]`
+
+In this example, you need to manually check the output types
+
+---
+
+### Type Specification
+#### RowDataPacket[]
+An array with the returned rows, for example:
+```ts
+import mysql, { RowDataPacket } from 'mysql2';
+
+const conn = mysql.createConnection({
+  user: 'test',
+  database: 'test',
+});
+
+conn.query<RowDataPacket[]>('SELECT 1 + 1 AS `test`;', (_err, rows) => {
+  console.log(rows);
+  /**
+   * @rows: [ { test: 2 } ]
+   */
+});
+```
+
+---
+
+#### RowDataPacket[][]
+- `rowsAsArray`
+  ```ts
+  import mysql, { RowDataPacket } from 'mysql2';
+
+  const conn = mysql.createConnection({
+    user: 'test',
+    database: 'test',
+    rowsAsArray: true,
+  });
+
+  const sql = `
+    SELECT 1 + 1 AS test, 2 + 2 AS test;
+  `;
+
+  conn.query<RowDataPacket[][]>(sql, (_err, rows) => {
+    console.log(rows);
+    /**
+    * @rows: [ [ 2, 4 ] ]
+    */
+  });
+  ```
+
+- `multipleStatements` with multiple queries
+  ```ts
+  import mysql, { RowDataPacket } from 'mysql2';
+
+  const conn = mysql.createConnection({
+    user: 'test',
+    database: 'test',
+    multipleStatements: true,
+  });
+
+  const sql = `
+    SELECT 1 + 1 AS test;
+    SELECT 2 + 2 AS test;
+  `;
+
+  conn.query<RowDataPacket[][]>(sql, (_err, rows) => {
+    console.log(rows);
+    /**
+    * @rows: [ [ { test: 2 } ], [ { test: 4 } ] ]
+    */
+  });
+  ```
+
+#### ResultSetHeader
+> In progress
+
+#### ProcedureCallPacket
+> In progress
+
+#### OkPacket
+> In progress
+
+#### OkPacket[]
+> In progress
+
+---
+
+## Examples
+
+You can also check various code examples using **MySQL2** and **TypeScript** to understand advanced concepts:
+> In progress
+
+- Extending and using **Interfaces** with `RowDataPacket`.
+- Checking for `ResultSetHeader` or `RowDataPacket[]` using **Procedure Calls**
+- Checking for `ResultSetHeader` or `RowDataPacket[][]` using **Procedure Calls**
+- Creating a custom **MySQL2** **Class**