Skip to content

Commit

Permalink
Add doc for closing connections (#2104)
Browse files Browse the repository at this point in the history
(cherry picked from commit d3f22f1)
  • Loading branch information
JoshMock authored and github-actions[bot] committed Dec 14, 2023
1 parent 813c60f commit 896b6ad
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/connecting.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This page contains the information you need to connect and use the Client with
* <<client-connect-proxy, Connecting through a proxy>>
* <<client-error-handling, Handling errors>>
* <<keep-alive, Keep-alive connections>>
* <<close-connections, Closing a client's connections>>
* <<product-check, Automatic product check>>

[[authentication]]
Expand Down Expand Up @@ -691,6 +692,20 @@ const client = new Client({
})
----

[discrete]
[[close-connections]]
=== Closing a client's connections

If you would like to close all open connections being managed by an instance of the client, use the `close()` function:

[source,js]
----
const client = new Client({
node: 'http://localhost:9200'
});
client.close();
----

[discrete]
[[product-check]]
=== Automatic product check
Expand Down

0 comments on commit 896b6ad

Please sign in to comment.