TypeScript: missing, wrong and refactoring types

[wellwelwel]

Please, don't use this area to indicate new Issues, give preference to opening a new Issue.

Known Issues

Pool

• Missing Connection URI overload in mysql import, like createPool('uri')
  • #2084
• Confusing maxIdle option description
  • #2070
  • #1858
  • #2073

Pool Cluster

It doesn't have any tests yet ⚠️

• Missing Connection URI overload, like poolCluster.add('conn', 'uri')
  • #2084
• Missing config option url in add method
  • #1991
  • #2084
• end, of and add methods can't be in a PoolCluster connection
  • #2084
• of type can't be a PoolCluster
  • #1991
  • #2036
  • #2084
• Pool Cluster is missing in promise.d.ts
  • #2035
  • #2084

Constants

• Missing export for Types (it's necessary to fix both JS and TS)
  • #1938
  • #2084

---

Notes

• All fixes need to be covered by tests (see practical examples here)
• If new issues are identified, they will be added here

---

🔬 About TypeScript Tests

The tests are based on TypeScript compilation and not executes the compiled code.

Reason: Given that the main codebase and its entire maintenance are carried out in JavaScript, creating tests in TypeScript could potentially hinder development in its primary language. It allows the development of the main driver and its types in parallel.
See: #1957 and #1995 (comment).

---

ℹ️ About refactoring

The PR #2067 solves all the following refactoring, but it has become too long and hard to review. Then, I plan to split it into smaller tasks and submit them again.

The idea behind the refactoring revolves around:

• Organizing and patterning the code for better readability and maintenance
• Improving the performance of the code editor when compiling the types in its display
• Increasing compatibility across multiple TypeScript configurations (tsconfig)

---

1) Small refactoring

• Include all *.ts files into tsconfig.json (except for tests)
  • #2073
• Resolve TS eslint errors
  • #2073
• Remove unused TS tests
  • #2073
• Remove @types/mocha, @types/chai, mocha and chai dependencies
  • #2073
• Then, include every *.ts file to lint script (including the tests)
  • #2073

2) Large refactoring

• Pattern all modules importing and exporting
  • #2073
• Join spread out types
  • #2075
• Create a reusable way for query and execute overloads
  • #2075

3) Optional refactoring

• Increasing compatibility with moduleResolution: nodenext
  • #2073
• Remove strictFunctionTypes: false from tsconfig.json
  • #2073

---

🕐 Open Issues that have possibly already been resolved

• Property 'releaseConnection' does not exist on type 'Pool'. #1761
• type error in v3.1.0 #1816
• Attribute "promise" does not exist on type "Connection" #1936

[wellwelwel]

@sidorares, I took the liberty of pinning this Issue, feel free to change it and this Issue content too 🙋🏻‍♂️