Skip to content

Add release event to Pool API docs #2928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 16, 2023
Merged

Add release event to Pool API docs #2928

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/pages/apis/pool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</Alert>

### 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`
Expand Down