docs: add RowDataPacket[] with rowsAsArray example

Author: wellwelwel

documentation/en/TypeScript-Examples.md

@@ -106,37 +106,38 @@ conn.query<RowDataPacket[]>('SHOW TABLES FROM `test`;', (_err, rows) => {
 });
 ```
 
----
+Using `rowsAsArray` option as `true`:
 
-### RowDataPacket[][]
-- When `rowsAsArray` option is `true`
-  ```ts
-  import mysql, { RowDataPacket } from 'mysql2';
+```ts
+import mysql, { RowDataPacket } from 'mysql2';
 
-  const conn = mysql.createConnection({
-    user: 'test',
-    database: 'test',
-    rowsAsArray: true,
-  });
+const conn = mysql.createConnection({
+  user: 'test',
+  database: 'test',
+  rowsAsArray: true,
+});
 
-  // SELECT
-  conn.query<RowDataPacket[][]>('SELECT 1 + 1 AS test, 2 + 2 AS test;', (_err, rows) => {
-    console.log(rows);
-    /**
-    * @rows: [ [ 2, 4 ] ]
-    */
-  });
+// SELECT
+conn.query<RowDataPacket[]>('SELECT 1 + 1 AS test, 2 + 2 AS test;', (_err, rows) => {
+  console.log(rows);
+  /**
+  * @rows: [ [ 2, 4 ] ]
+  */
+});
 
-  // SHOW
-  conn.query<RowDataPacket[][]>('SHOW TABLES FROM `test`;', (_err, rows) => {
-    console.log(rows);
-    /**
-    * @rows: [ [ 'test' ] ]
-    */
-  });
-  ```
+// SHOW
+conn.query<RowDataPacket[]>('SHOW TABLES FROM `test`;', (_err, rows) => {
+  console.log(rows);
+  /**
+  * @rows: [ [ 'test' ] ]
+  */
+});
+```
 
-- When `multipleStatements` is `true` with multiple queries
+---
+
+### RowDataPacket[][]
+Using `multipleStatements`option as `true` with multiple queries:
   ```ts
   import mysql, { RowDataPacket } from 'mysql2';
 
@@ -162,7 +163,7 @@ conn.query<RowDataPacket[]>('SHOW TABLES FROM `test`;', (_err, rows) => {
 ---
 
 ### ResultSetHeader
-For `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, etc.
+For `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, etc.:
 ```ts
 import mysql, { ResultSetHeader } from 'mysql2';
 
@@ -194,7 +195,7 @@ conn.query<ResultSetHeader>(sql, (_err, result) => {
 ---
 
 ### ResultSetHeader[]
-For multiples `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, etc. when using `multipleStatements` as `true`
+For multiples `INSERT`, `UPDATE`, `DELETE`, `TRUNCATE`, etc. when using `multipleStatements` as `true`:
 
 ```ts
 import mysql, { ResultSetHeader } from 'mysql2';
@@ -240,9 +241,7 @@ conn.query<ResultSetHeader[]>(sql, (_err, results) => {
 ---
 
 ### ProcedureCallPacket
-By performing a **Call Procedure** using `INSERT`, `UPDATE`, etc., the return will be a `ProcedureCallPacket<ResultSetHeader>` (even if you perform multiples queries and set `multipleStatements` to `true`).
-
-> For `CREATE PROCEDURE` and `DROP PROCEDURE`, these returns will be the *default* `ResultSetHeader`.
+By performing a **Call Procedure** using `INSERT`, `UPDATE`, etc., the return will be a `ProcedureCallPacket<ResultSetHeader>` (even if you perform multiples queries and set `multipleStatements` to `true`):
 
 ```ts
 import mysql, { ProcedureCallPacket, ResultSetHeader } from 'mysql2';
@@ -283,6 +282,8 @@ conn.query<ProcedureCallPacket<ResultSetHeader>>(sql, (_err, result) => {
 });
 ```
 
+> For `CREATE PROCEDURE` and `DROP PROCEDURE`, these returns will be the *default* `ResultSetHeader`.
+
 By using `SELECT` and `SHOW` queries in a **Procedure Call**, it groups the results as:
 ```tsx
 // ProcedureCallPacket<RowDataPacket[]>
@@ -291,6 +292,7 @@ By using `SELECT` and `SHOW` queries in a **Procedure Call**, it groups the resu
 // ProcedureCallPacket<RowDataPacket[][]>
 [...RowDataPacket[][], ResultSetHeader]
 ```
+
 For `ProcedureCallPacket<RowDataPacket[]>` and `ProcedureCallPacket<RowDataPacket[][]>`, please see the following examples.
 
 ---

examples/typescript/row-data-packet-row-as-array.ts

@@ -0,0 +1,74 @@
+/**
+ * The types are explicity for learning purpose
+ * By extending the `RowDataPacket`, you can use your Interface in `query` and `execute`
+ */
+
+import mysql, {
+  ConnectionOptions,
+  ResultSetHeader,
+  RowDataPacket,
+} from 'mysql2/promise';
+
+ interface User extends RowDataPacket {
+   /** id */
+   0: number;
+   /** name */
+   1: string;
+ }
+
+(async () => {
+  const access: ConnectionOptions = {
+    host: '',
+    user: '',
+    password: '',
+    database: '',
+  };
+
+  const conn = await mysql.createConnection(access);
+
+  /** Deleting the `users` table, if it exists */
+  await conn.query<ResultSetHeader>('DROP TABLE IF EXISTS `users`;');
+
+  /** Creating a minimal user table */
+  await conn.query<ResultSetHeader>(
+    'CREATE TABLE `users` (`id` INT(11) AUTO_INCREMENT, `name` VARCHAR(50), PRIMARY KEY (`id`));',
+  );
+
+  /** Inserting some users */
+  const [inserted] = await conn.execute<ResultSetHeader>(
+    'INSERT INTO `users`(`name`) VALUES(?), (?), (?), (?);',
+    ['Josh', 'John', 'Marie', 'Gween'],
+  );
+
+  console.log('Inserted:', inserted.affectedRows);
+
+  /** Getting users */
+  const [users] = await conn.query<User[]>(
+    'SELECT * FROM `users` ORDER BY `name` ASC;',
+  );
+
+  users.forEach((user) => {
+    console.log('-----------');
+    console.log('id:  ', user[0]);
+    console.log('name:', user[1]);
+  });
+
+  await conn.end();
+})();
+
+/** Output
+  *
+  * Inserted: 4
+  * -----------
+  * id:   4
+  * name: Gween
+  * -----------
+  * id:   2
+  * name: John
+  * -----------
+  * id:   1
+  * name: Josh
+  * -----------
+  * id:   3
+  * name: Marie
+  */