Skip to content

Commit

Permalink
Update docs for .close()
Browse files Browse the repository at this point in the history
  • Loading branch information
EvanHahn committed Apr 15, 2024
1 parent bc566d8 commit d32e778
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ after the indexer is closed.
Stop the indexer and flush index state to storage. This will not close the
underlying storage - it is up to the consumer to do that.

No-op if called more than once.

### indexer.unlink()

Unlink all index files.
Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ class MultiCoreIndexer extends TypedEmitter {
* Stop the indexer and flush index state to storage. This will not close the
* underlying storage - it is up to the consumer to do that.
*
* Rejects if called more than once.
* No-op if called more than once.
*/
async close() {
if (!this.#isOpen()) return
Expand Down

0 comments on commit d32e778

Please sign in to comment.