feat: reject if closed state is incorrect #42
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some methods, like `addCore()`, now throw if called after calling `close()`. `unlink()` is the opposite, and should only be called after the indexer is closed. This is arguably a breaking change, but I feel that changing undefined behavior is not breaking.
EvanHahn
commented
Apr 5, 2024
| @@ -139,14 +139,25 @@ Type: `Hypercore` | |||
| Add a hypercore to the indexer. Must have the same value encoding as other | |||
| hypercores already in the indexer. | |||
|
|
|||
| Rejects if called after the indexer is closed. | |||
|
|
|||
| ### indexer.idle() | |||
There was a problem hiding this comment.
This method was previously undocumented. Because it has a behavior change, I documented it here.
| @@ -12,3 +12,13 @@ function pDefer() { | |||
| return deferred | |||
| } | |||
| exports.pDefer = pDefer | |||
|
|
|||
| class ExhaustivenessError extends Error { | |||
There was a problem hiding this comment.
Copy-pasted from mapeo-core-next.
This was referenced Apr 5, 2024
achou11
approved these changes
Apr 15, 2024
index.js
Outdated
| * 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. |
There was a problem hiding this comment.
is this preferred over no-oping when closed already?
There was a problem hiding this comment.
should update the docs with this note to describe the behavior anyways
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some methods, like
addCore(), now throw if called after callingclose().unlink()is the opposite, and should only be called after the indexer is closed.This is arguably a breaking change, but I feel that changing undefined behavior is not breaking.
Closes #21.