feat: getByDocId can optionally throw
#959
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
EvanHahn
force-pushed
the
getByDocId-allow-missing
branch
from
376be17
to
d260252
Compare
EvanHahn
commented
Nov 12, 2024
| @@ -186,7 +200,7 @@ export class DataType extends TypedEmitter { | |||
| } | |||
|
|
|||
| /** | |||
| * @param {MapeoDoc} doc | |||
| * @param {any} doc | |||
There was a problem hiding this comment.
This change, and the one below, come from #951.
This adds a new option to `DataType.prototype.getByDocId()`, `mustBeFound`. If set to `false` and the document doesn't exist, it will resolve with `null` instead of throwing. If the option is missing or set to `true`, the current behavior is maintained (throwing if the document is missing). I think this is a useful feature on its own but will also hopefully make at least one [upcoming change][0] a little easier. [0]: #188
EvanHahn
force-pushed
the
getByDocId-allow-missing
branch
from
d260252
to
56f7e18
Compare
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.
This adds a new option to
DataType.prototype.getByDocId(),mustBeFound. If set tofalseand the document doesn't exist, it will resolve withnullinstead of throwing.If the option is missing or set to
true, the current behavior is maintained (throwing if the document is missing).I think this is a useful feature on its own but will also hopefully make at least one upcoming change a little easier.