Refine SingleFilterSearchRequest interface to permit array values for the IN and NIN operators
#454
+38
−7
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
…or the `IN` and `NIN` operators
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.
Resolved: #453
Why?
Currently, the SingleFilterSearchRequest interface in the intercom-node library does not enforce that the value property be an array when the operator is set to "IN" or "NIN". This can lead to runtime errors if a string is provided instead of an array.
How?
Modify the SingleFilterSearchRequest interface to ensure type safety by differentiating between operators that require an array for value and those that do not.
I noticed that the interface file is indicated as auto-generated with the comment:
intercom-node/src/api/types/SingleFilterSearchRequest.ts
Lines 1 to 3 in 49f4faf
However, I'm not familiar with the specifics of the generation process. As such, this PR serves as a conceptual proposal for addressing the issue.