From 492aa5eb3126793af7d21a6ffac06c23267f5d3b Mon Sep 17 00:00:00 2001 From: Nathan Friedly Date: Fri, 25 Aug 2023 15:54:17 -0400 Subject: [PATCH] Document client.shutdown() command I started to file this as a feature request, but then checked the source and realized that it was there, just undocumented. This adds it to the example at the top and the list of other methods near the bottom. --- packages/memcache-client/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/memcache-client/README.md b/packages/memcache-client/README.md index 2e860ec..c89e7fd 100644 --- a/packages/memcache-client/README.md +++ b/packages/memcache-client/README.md @@ -133,6 +133,9 @@ client.cmd("incr foo 5", { noreply: true }); // send any arbitrary data (remember \r\n) client.send("set foo 0 0 5\r\nhello\r\n").then((r) => assert.deepEqual(r, ["STORED"])); + +// disconnect from the memcached server(s) +client.shutdown(); ``` ## Commands with a method @@ -359,6 +362,7 @@ For the `cas` command, `options` must contain a `casUniq` value that you receive - `client.store(cmd, key, value, [optons], [callback])` - `client.retrieve(cmd, key, [options], [callback])` - `client.xretrieve(cmd, key)` +- `client.shutdown()` ## License