Skip to content
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.

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

Add documentation for closing a client connection #2081

Closed

Conversation

karlbecker
Copy link

I struggled to find any reference to the close() function in the JavaScript library's documentation, so I thought adding it here would be helpful to many people.

I might be getting some of the terminology wrong, so please feel free to clarify / improve what I've written. Happy to answer any questions you have or redo this if there's a different file I should be editing.

Thanks!

I could not find this anywhere in the JavaScript client docs, and I think it's worth a mention here
Copy link

❌ Author of the following commits did not sign a Contributor Agreement:
57e18a1, d18f098

Please, read and sign the above mentioned agreement if you want to contribute to this project

@karlbecker
Copy link
Author

I have not signed the contributor agreement. However, I think it would be very beneficial for the docs to mention how to close a connection, since I haven't seen anything like this in the docs.

If you want to close this PR, that's fine, but could someone with Elastic open up a different PR to make sure documentation of close() gets added to the docs? It would be really helpful, since the only places I found it were Stack Overflow - https://stackoverflow.com/questions/59439108/elasticsearch-js-client-close - and in an Elasticsearch client changelog: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/changelog-client.html#_calling_client_close_will_reject_new_requests

Thanks!

@JoshMock
Copy link
Member

@karlbecker closing in favor of #2104. Basically the same idea, to which I give you credit, but wanted to get it fixed since you hadn't signed the CLA. 🙏

@JoshMock JoshMock closed this Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants