From c82fdbc538aa29aee70965a0d3d4103348090c9d Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Mon, 7 Jun 2021 22:06:56 +0200 Subject: [PATCH] Clarify close() documentation (#197) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d89140..ce72dff 100644 --- a/README.md +++ b/README.md @@ -197,7 +197,7 @@ If no callback is passed, a promise is returned. close() closes the underlying store. The callback will receive any error encountered during closing as the first argument. -You should always clean up your `levelup` instance by calling `close()` when you no longer need it to free up resources. A store cannot be opened by multiple instances of `levelup` simultaneously. +A `levelup` instance has associated resources like file handles and locks. When you no longer need your `levelup` instance (for the remainder of your program) call `close()` to free up resources. The underlying store cannot be opened by multiple instances of `levelup` simultaneously. If no callback is passed, a promise is returned.