mariadb-corporation / mariadb-connector-nodejs

MariaDB Connector/Node.js is used to connect applications developed on Node.js to MariaDB and MySQL databases. MariaDB Connector/Node.js is LGPL licensed.
GNU Lesser General Public License v2.1
366 stars 91 forks source link

Docs: Inconsistency default value of connectTimeout between docs and type comments #192

Closed bc-m closed 2 years ago

bc-m commented 2 years ago

Found a mismatch between docs and type about the default value of connectTimeout.

Documentation says 1 seconds since v2.5.6: https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/64ca753b7aa1a5d13e8e14799af5bda4271d5ce4/documentation/connection-options.md

Commend above Type says 10 seconds: https://github.com/mariadb-corporation/mariadb-connector-nodejs/blob/64ca753b7aa1a5d13e8e14799af5bda4271d5ce4/types/index.d.ts#L214

rusher commented 2 years ago

PR merged, so closing