From 16724657688eb2a8af46d6a80bfc7d37ef21b4f2 Mon Sep 17 00:00:00 2001 From: Bruno Moreira Date: Sun, 5 Jun 2016 19:03:36 +0100 Subject: [PATCH] Add destroy to docs (#411) Just found this missing function. --- docs/docs_client.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/docs_client.rst b/docs/docs_client.rst index 457904d05..c9a206bd4 100644 --- a/docs/docs_client.rst +++ b/docs/docs_client.rst @@ -185,6 +185,14 @@ logout(`callback`) Logs the client out and closes the WebSocket connections. +- **callback** - `function` that takes the following parameter: + - **error** - An error if any occurred + +destroy(`callback`) +~~~~~~~~~~~~~~~~~~~ + +Similar to logout but should be used if you're not going to create the Client again later in your program. + - **callback** - `function` that takes the following parameter: - **error** - An error if any occurred