maxIdle confusion

[GingerAdonis]

There are 2 problems with the following description of maxIdle.

1. It's not the minimum number of idle connections, but a maximum.
2. The default is the same as connectionLimit option, not 10.

/**
* The minimum number of idle connections. (Default: 10)
*/
maxIdle?: number;

[wellwelwel]

According to documentation:

• node-mysql2/README.md

  Line 137 in fefe036

  maxIdle: 10, // max idle connections, the default value is the same as `connectionLimit`

And confirming the default value as connectionLimit in practice:

• node-mysql2/lib/pool_config.js

  Lines 18 to 20 in fefe036

  	this.maxIdle = isNaN(options.maxIdle)
  	? this.connectionLimit
  	: Number(options.maxIdle);

---

@GingerAdonis, thanks for report it.

For now, I will change that description in PR #2067 (waiting for a third review by the community).
In case it isn't merged until the next release, I can change that description separately 🙋🏻‍♂️

[wellwelwel]

@GingerAdonis, can you check it in version ^3.4.0?

[GingerAdonis]

Looks good to me. Thank you!