Skip to content

Commit 0f3f3fc

Browse files
committed
chore: add minimum TypeScript requirement
1 parent d9c2b6d commit 0f3f3fc

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

documentation/en/TypeScript-Examples.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ npm install --save-dev @types/node
88

99
> The `@types/node` ensure the proper interaction between **TypeScript** and the **Node.js** modules used by **MySQL2** (*net*, *events*, *stream*, *tls*, etc.).
1010
11+
Requires **TypeScript** `>=4.5.2`.
12+
13+
---
14+
1115
## Usage
1216
You can import **MySQL2** in two ways:
1317
- By setting the `esModuleInterop` option to `true` in `tsconfig.json`
@@ -287,16 +291,15 @@ By using `SELECT` and `SHOW` queries in a **Procedure Call**, it groups the resu
287291
// ProcedureCallPacket<RowDataPacket[][]>
288292
[...RowDataPacket[][], ResultSetHeader]
289293
```
290-
For `ProcedureCallPacket<RowDataPacket[]>` and `ProcedureCallPacket<RowDataPacket[][]>`, please see the following advanced examples.
294+
For `ProcedureCallPacket<RowDataPacket[]>` and `ProcedureCallPacket<RowDataPacket[][]>`, please see the following examples.
291295

292296
---
293297

294298
## Examples
295299

296-
You can also check various code examples using **MySQL2** and **TypeScript** to understand advanced concepts:
297-
> In progress
300+
You can also check some code examples using **MySQL2** and **TypeScript** to understand advanced concepts:
298301

299-
- Extending and using **Interfaces** with `RowDataPacket`.
300-
- Checking for `ResultSetHeader` or `RowDataPacket[]` using **Procedure Calls**
301-
- Checking for `ResultSetHeader` or `RowDataPacket[][]` using **Procedure Calls**
302-
- Creating a custom **MySQL2** **Class**
302+
- Extending and using **Interfaces** with `RowDataPacket` (*in progress*)
303+
- Checking for `ResultSetHeader` or `RowDataPacket[]` using **Procedure Calls** (*in progress*)
304+
- Checking for `ResultSetHeader` or `RowDataPacket[][]` using **Procedure Calls** (*in progress*)
305+
- Creating a custom **MySQL2** **Class** (*in progress*)

0 commit comments

Comments
 (0)