feat: flatten only arrayble search params before search #214
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
Introduces a new utility type, ArrayableSearchParams, and a constant, searchParamsArrayKeys. The ArrayableSearchParams typefilters the properties of the SearchParams type, selecting only thosewhose type is an array. The searchParamsArrayKeys constant is anobject that indicates which parameters are expected to be arrays. Thisenhancement provides a compile-time check for array parameters,improving type safety and code readability.
This commit adds a new utility type, ConvertArrayToString, and a function, combineAndFlattenArraySearchParams. The ConvertArrayToStringtype transforms array properties of an object type into stringproperties, leaving non-array properties unchanged. ThecombineAndFlattenArraySearchParams function takes an object of searchparameters, potentially containing array values, and returns a newobject where array values are converted to comma-separated strings. This is beneficial for preparing search parameters for API requestswhere array parameters need to be serialized.
The handling of search parameters in the `search` method of `SearchOnlyDocuments` has been refactored. The logic for combining and flattening array search parameters has been moved to a utility function `combineAndFlattenArraySearchParams` for better code reusability and readability.
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.
Change Summary
Introduces a new utility function and types for only checking search parameters that can be either a base type, or an array of said type. Instead of checking through all of the possible parameters (more than 50), it instead iterates over a specific part (10), improving performance and ensuring maintainability, if non-search parameters should still retain their original array format in the future.
PR Checklist