Add function parameter constraint examples to numeric comparison types#1357
Merged
sindresorhus merged 3 commits intosindresorhus:mainfrom Feb 14, 2026
Merged
Conversation
som-sm
requested changes
Feb 10, 2026
Collaborator
som-sm
left a comment
There was a problem hiding this comment.
Please resolve the conflict.
som-sm
reviewed
Feb 10, 2026
source/greater-than.d.ts
Outdated
| setPositive(-1); | ||
|
|
||
| // @ts-expect-error | ||
| setPositive(0); |
Collaborator
There was a problem hiding this comment.
Please also add similar examples to LessThan, LessThanOrEqual and GreaterThanOrEqual.
Contributor
Author
There was a problem hiding this comment.
Done. Added similar examples to all three types and resolved the conflict.
GreaterThan: Add example for function parameter constraint772c668 to
157ebd9
Compare
bfde8c2 to
f18995b
Compare
som-sm
approved these changes
Feb 14, 2026
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
3 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.
Closes #957
Adds a second
@exampleblock toGreaterThanshowing how to use it as a function parameter constraint.Users attempting to use
GreaterThan<N, 0>directly as a parameter type getneverbecause the generic is unresolved. The added example demonstrates the correct pattern using a conditional type: