Promise Pool: Inconsistent types, missing releaseConnection function

[perry-mitchell]

Hi,

I'm looking at implementing a connection pool, using the promise entry, but as I can see here there isn't a releaseConnection function.

Additionally, when looking at the standard connection pool types, the releaseConnection method is not typed at all.

[sidorares]

there is a PromiseConnection.release -

node-mysql2/promise.js

Lines 87 to 89 in 131c6b8

	release() {
	this.connection.release();
	}

which is typed here

node-mysql2/promise.d.ts

Line 85 in dbb344e

release(): void;

[perry-mitchell]

You're right, it is. Couldn't find it in the documentation.

What about the types for releaseConnection on the standard pool?

[sidorares]

You're right, it is. Couldn't find it in the documentation.

I think the promise wrapper is increasingly becoming the most popular api and deserve place at the beginning of readme, while callback style api can reuse documentation from mysqljs/mysql

What about the types for releaseConnection on the standard pool?

looks like it's outdated, now deprecated PoolConnection.end() used to be a way to release connection back into the pool

[sidorares]

@perry-mitchell would you like to contribute a fix to missing typings? If you can think of some test harness that would be awesome ( have a unit test in TS that can both run without runtime errors and pass static type checks )

[sidorares]

I'll close this one as we also discuss same issue in #1761