From 93c802fc6ac0e6c18a07e794fe6fb17dc7c38198 Mon Sep 17 00:00:00 2001 From: "Ryan B. Harvey" Date: Fri, 10 Mar 2023 13:11:27 -0600 Subject: [PATCH] Add release event to Pool API docs --- docs/pages/apis/pool.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/pages/apis/pool.mdx b/docs/pages/apis/pool.mdx index 497e5253f..6323f2e2d 100644 --- a/docs/pages/apis/pool.mdx +++ b/docs/pages/apis/pool.mdx @@ -271,6 +271,12 @@ The error listener is passed the error as the first argument and the client upon uncaught error and potentially crash your node process. +### release + +`pool.on('release', (err: Error, client: Client) => void) => void` + +Whenever a client is released back into the pool, the pool will emit the `release` event. + ### remove `pool.on('remove', (client: Client) => void) => void`