fix(documents): throw on empty lists of documents#262
Merged
Conversation
jasonbosco
requested changes
Feb 5, 2025
Member
jasonbosco
left a comment
jasonbosco
left a comment
There was a problem hiding this comment.
Could you add a unit test for this?
- add test for empty array input - add test for empty string input - add test for null input - add test for undefined input
Collaborator
Author
Added tests in 3a55318 |
jasonbosco
approved these changes
Feb 6, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
TDLR
Addresses #188
Change Summary
This pull request introduces a new error handling mechanism in the
Documentsclass within thesrc/Typesense/Documents.tsfile. The main changes include the addition of a new error type and checks to ensure that provided documents are not empty.Error handling improvements:
src/Typesense/Documents.ts: Added a new error typeRequestMalformedto the import statement from./Errors.src/Typesense/Documents.ts: Added a check to throw aRequestMalformederror if the provided documents array is empty.src/Typesense/Documents.ts: Added a check to throw aRequestMalformederror if the provided documents string is empty.Utility function addition:
src/Typesense/Documents.ts: Added a new utility functionisEmptyStringto check if a string is null, undefined, or empty.PR Checklist