Repository navigation
IsStringLiteral: Fix instantiations with infinite string types - #1044
Merged
sindresorhus merged 6 commits intoJan 20, 2025
Merged
Conversation
som-sm
force-pushed
the
fix/is-string-literal-with-infinite-string-types
branch
3 times, most recently
from
January 16, 2025 10:53
6467614 to
1edeaf9
Compare
som-sm
marked this pull request as ready for review
January 16, 2025 10:55
som-sm
force-pushed
the
fix/is-string-literal-with-infinite-string-types
branch
2 times, most recently
from
January 16, 2025 11:10
9842e33 to
9c842e5
Compare
som-sm
force-pushed
the
fix/is-string-literal-with-infinite-string-types
branch
from
January 16, 2025 11:12
9c842e5 to
0ca76a9
Compare
sindresorhus
approved these changes
Jan 17, 2025
sindresorhus
deleted the
fix/is-string-literal-with-infinite-string-types
branch
January 20, 2025 10:13
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
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.
Fixes #1032
Found a really nice trick to solve this! Refer to the code comments explaining how it works:
type-fest/source/is-literal.d.ts
Lines 116 to 122 in 06037a9
This fix will make this type quite useful because almost all string utilities will require an
IsStringLiteralcheck. For example:I'll open up a separate PR fixing all the above mentioned cases.
I've mentioned the same as an example in the documentation:
type-fest/source/is-literal.d.ts
Lines 97 to 110 in 06037a9
NOTE: If
IsStringLiteralis instantiated with a union of literal strings and non-string types, it currently returnsfalsebecause not all union members are literal strings. However, after this PR, cases like these would instead returnboolean.To me, the current behaviour seems more like a bug than an intentional choice, as returning
booleanmakes more sense and allows users to decide how to handle mixed union cases.