Skip to content

Commit ed2be49

Browse files
committed
More specific inference for constrained 'infer' types in template literal types
1 parent e64f04b commit ed2be49

File tree

6 files changed

+1116
-6
lines changed

6 files changed

+1116
-6
lines changed

src/compiler/checker.ts

Lines changed: 81 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21762,13 +21762,31 @@ namespace ts {
2176221762
sourceEnd.slice(sourceEnd.length - endLen) !== targetEnd.slice(targetEnd.length - endLen);
2176321763
}
2176421764

21765-
function isValidBigIntString(s: string): boolean {
21765+
/**
21766+
* Tests whether the provided string can be parsed as a number.
21767+
* @param s The string to test.
21768+
* @param roundTripOnly Indicates the resulting number matches the input when converted back to a string.
21769+
*/
21770+
function isValidNumberString(s: string, roundTripOnly: boolean): boolean {
21771+
if (s === "") return false;
21772+
const n = +s;
21773+
return isFinite(n) && (!roundTripOnly || "" + n === s);
21774+
}
21775+
21776+
/**
21777+
* Tests whether the provided string can be parsed as a bigint.
21778+
* @param s The string to test.
21779+
* @param roundTripOnly Indicates the resulting bigint matches the input when converted back to a string.
21780+
*/
21781+
function isValidBigIntString(s: string, roundTripOnly: boolean): boolean {
21782+
if (s === "") return false;
2176621783
const scanner = createScanner(ScriptTarget.ESNext, /*skipTrivia*/ false);
2176721784
let success = true;
2176821785
scanner.setOnError(() => success = false);
2176921786
scanner.setText(s + "n");
2177021787
let result = scanner.scan();
21771-
if (result === SyntaxKind.MinusToken) {
21788+
const negative = result === SyntaxKind.MinusToken;
21789+
if (negative) {
2177221790
result = scanner.scan();
2177321791
}
2177421792
const flags = scanner.getTokenFlags();
@@ -21777,7 +21795,8 @@ namespace ts {
2177721795
// * a bigint can be scanned, and that when it is scanned, it is
2177821796
// * the full length of the input string (so the scanner is one character beyond the augmented input length)
2177921797
// * it does not contain a numeric seperator (the `BigInt` constructor does not accept a numeric seperator in its input)
21780-
return success && result === SyntaxKind.BigIntLiteral && scanner.getTextPos() === (s.length + 1) && !(flags & TokenFlags.ContainsSeparator);
21798+
return success && result === SyntaxKind.BigIntLiteral && scanner.getTextPos() === (s.length + 1) && !(flags & TokenFlags.ContainsSeparator)
21799+
&& (!roundTripOnly || s === pseudoBigIntToString({ negative, base10Value: parsePseudoBigInt(scanner.getTokenValue()) }));
2178121800
}
2178221801

2178321802
function isValidTypeForTemplateLiteralPlaceholder(source: Type, target: Type): boolean {
@@ -21786,8 +21805,8 @@ namespace ts {
2178621805
}
2178721806
if (source.flags & TypeFlags.StringLiteral) {
2178821807
const value = (source as StringLiteralType).value;
21789-
return !!(target.flags & TypeFlags.Number && value !== "" && isFinite(+value) ||
21790-
target.flags & TypeFlags.BigInt && value !== "" && isValidBigIntString(value) ||
21808+
return !!(target.flags & TypeFlags.Number && isValidNumberString(value, /*roundTripOnly*/ false) ||
21809+
target.flags & TypeFlags.BigInt && isValidBigIntString(value, /*roundTripOnly*/ false) ||
2179121810
target.flags & (TypeFlags.BooleanLiteral | TypeFlags.Nullable) && value === (target as IntrinsicType).intrinsicName);
2179221811
}
2179321812
if (source.flags & TypeFlags.TemplateLiteral) {
@@ -22365,7 +22384,63 @@ namespace ts {
2236522384
// succeed. That would be a pointless and confusing outcome.
2236622385
if (matches || every(target.texts, s => s.length === 0)) {
2236722386
for (let i = 0; i < types.length; i++) {
22368-
inferFromTypes(matches ? matches[i] : neverType, types[i]);
22387+
const source = matches ? matches[i] : neverType;
22388+
const target = types[i];
22389+
22390+
// If we are inferring from a string literal type to a type variable whose constraint includes one of the
22391+
// allowed template literal placeholder types, infer from a literal type corresponding to the constraint.
22392+
let sourceTypes: Type[] | undefined;
22393+
if (source.flags & TypeFlags.StringLiteral && target.flags & TypeFlags.TypeVariable) {
22394+
const inferenceContext = getInferenceInfoForType(target);
22395+
const constraint = inferenceContext ? getConstraintOfTypeParameter(inferenceContext.typeParameter) : undefined;
22396+
if (inferenceContext && constraint) {
22397+
const str = (source as StringLiteralType).value;
22398+
const constraintTypes = constraint.flags & TypeFlags.Union ? (constraint as UnionType).types : [constraint];
22399+
for (const constraintType of constraintTypes) {
22400+
if (constraintType.flags & TypeFlags.StringLike) {
22401+
sourceTypes ??= [];
22402+
sourceTypes.push(source);
22403+
}
22404+
if (constraintType.flags & TypeFlags.NumberLike && isValidNumberString(str, /*roundTripOnly*/ true)) {
22405+
sourceTypes ??= [];
22406+
sourceTypes.push(getNumberLiteralType(+str));
22407+
}
22408+
if (constraintType.flags & TypeFlags.BigIntLike && isValidBigIntString(str, /*roundTripOnly*/ true)) {
22409+
const negative = str.startsWith("-");
22410+
const base10Value = parsePseudoBigInt(`${negative ? str.slice(1) : str}n`);
22411+
sourceTypes ??= [];
22412+
sourceTypes.push(getBigIntLiteralType({ negative, base10Value }));
22413+
}
22414+
if (constraintType.flags & TypeFlags.BooleanLike) {
22415+
if (str === trueType.intrinsicName) {
22416+
sourceTypes ??= [];
22417+
sourceTypes.push(trueType);
22418+
}
22419+
else if (str === falseType.intrinsicName) {
22420+
sourceTypes ??= [];
22421+
sourceTypes.push(falseType);
22422+
}
22423+
}
22424+
if (constraintType.flags & TypeFlags.Null && str === nullType.intrinsicName) {
22425+
sourceTypes ??= [];
22426+
sourceTypes.push(nullType);
22427+
}
22428+
if (constraintType.flags & TypeFlags.Undefined && str === undefinedType.intrinsicName) {
22429+
sourceTypes ??= [];
22430+
sourceTypes.push(undefinedType);
22431+
}
22432+
}
22433+
}
22434+
}
22435+
22436+
if (sourceTypes) {
22437+
for (const source of sourceTypes) {
22438+
inferFromTypes(source, target);
22439+
}
22440+
}
22441+
else {
22442+
inferFromTypes(source, target);
22443+
}
2236922444
}
2237022445
}
2237122446
}
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
tests/cases/conformance/types/literal/templateLiteralTypes4.ts(93,12): error TS2345: Argument of type '2' is not assignable to parameter of type '0 | 1'.
2+
tests/cases/conformance/types/literal/templateLiteralTypes4.ts(97,12): error TS2345: Argument of type '2' is not assignable to parameter of type '0 | 1'.
3+
4+
5+
==== tests/cases/conformance/types/literal/templateLiteralTypes4.ts (2 errors) ====
6+
type Is<T extends U, U> = T;
7+
8+
type T0 = "100" extends `${Is<infer N, number>}` ? N : never; // 100
9+
type T1 = "-100" extends `${Is<infer N, number>}` ? N : never; // -100
10+
type T2 = "1.1" extends `${Is<infer N, number>}` ? N : never; // 1.1
11+
type T3 = "8e-11" extends `${Is<infer N, number>}` ? N : never; // 8e-11 (0.00000000008)
12+
type T4 = "0x10" extends `${Is<infer N, number>}` ? N : never; // number (not round-trippable)
13+
type T5 = "0o10" extends `${Is<infer N, number>}` ? N : never; // number (not round-trippable)
14+
type T6 = "0b10" extends `${Is<infer N, number>}` ? N : never; // number (not round-trippable)
15+
type T7 = "10e2" extends `${Is<infer N, number>}` ? N : never; // number (not round-trippable)
16+
type T8 = "abcd" extends `${Is<infer N, number>}` ? N : never; // never
17+
18+
type T10 = "100" extends `${Is<infer N, bigint>}` ? N : never; // 100n
19+
type T11 = "-100" extends `${Is<infer N, bigint>}` ? N : never; // -100n
20+
type T12 = "0x10" extends `${Is<infer N, bigint>}` ? N : never; // bigint (not round-trippable)
21+
type T13 = "0o10" extends `${Is<infer N, bigint>}` ? N : never; // bigint (not round-trippable)
22+
type T14 = "0b10" extends `${Is<infer N, bigint>}` ? N : never; // bigint (not round-trippable)
23+
type T15 = "1.1" extends `${Is<infer N, bigint>}` ? N : never; // never
24+
type T16 = "10e2" extends `${Is<infer N, bigint>}` ? N : never; // never
25+
type T17 = "abcd" extends `${Is<infer N, bigint>}` ? N : never; // never
26+
27+
type T20 = "true" extends `${Is<infer T, boolean>}` ? T : never; // true
28+
type T21 = "false" extends `${Is<infer T, boolean>}` ? T : never; // false
29+
type T22 = "abcd" extends `${Is<infer T, boolean>}` ? T : never; // never
30+
31+
type T30 = "null" extends `${Is<infer T, null>}` ? T : never; // null
32+
type T31 = "abcd" extends `${Is<infer T, null>}` ? T : never; // never
33+
34+
type T40 = "undefined" extends `${Is<infer T, undefined>}` ? T : never; // undefined
35+
type T41 = "abcd" extends `${Is<infer T, undefined>}` ? T : never; // never
36+
37+
type T50 = "100" extends `${Is<infer T, string | number | bigint | boolean | null | undefined>}` ? T : never; // "100" | 100 | 100n
38+
type T51 = "1.1" extends `${Is<infer T, string | number | bigint | boolean | null | undefined>}` ? T : never; // "100" | 1.1
39+
type T52 = "true" extends `${Is<infer T, string | number | bigint | boolean | null | undefined>}` ? T : never; // "true" | true
40+
type T53 = "false" extends `${Is<infer T, string | number | bigint | boolean | null | undefined>}` ? T : never; // "false" | false
41+
type T54 = "null" extends `${Is<infer T, string | number | bigint | boolean | null | undefined>}` ? T : never; // "null" | null
42+
type T55 = "undefined" extends `${Is<infer T, string | number | bigint | boolean | null | undefined>}` ? T : never; // "undefined" | undefined
43+
44+
type NumberFor<S extends string> = S extends `${Is<infer N, number>}` ? N : never;
45+
type T60 = NumberFor<"100">; // 100
46+
type T61 = NumberFor<any>; // never
47+
type T62 = NumberFor<never>; // never
48+
49+
// example use case:
50+
interface FieldDefinition {
51+
readonly name: string;
52+
readonly type: "i8" | "i16" | "i32" | "i64" | "u8" | "u16" | "u32" | "u64" | "f32" | "f64";
53+
}
54+
55+
type FieldType<T extends FieldDefinition["type"]> =
56+
T extends "i8" | "i16" | "i32" | "u8" | "u16" | "u32" | "f32" | "f64" ? number :
57+
T extends "f32" | "f64" ? bigint :
58+
never;
59+
60+
// Generates named members like `{ x: number, y: bigint }` from `[{ name: "x", type: "i32" }, { name: "y", type: "i64" }]`
61+
type TypedObjectNamedMembers<TDef extends readonly FieldDefinition[]> = {
62+
[P in TDef[number]["name"]]: FieldType<Extract<TDef[number], { readonly name: P }>["type"]>;
63+
};
64+
65+
// Generates ordinal members like `{ 0: number, 1: bigint }` from `[{ name: "x", type: "i32" }, { name: "y", type: "i64" }]`
66+
type TypedObjectOrdinalMembers<TDef extends readonly FieldDefinition[]> = {
67+
[I in Extract<keyof TDef, `${number}`>]: FieldType<Extract<TDef[I], FieldDefinition>["type"]>;
68+
};
69+
70+
// Default members
71+
interface TypedObjectMembers<TDef extends readonly FieldDefinition[]> {
72+
// get/set a field by name
73+
get<K extends TDef[number]["name"]>(key: K): FieldType<Extract<TDef[number], { readonly name: K }>["type"]>;
74+
set<K extends TDef[number]["name"]>(key: K, value: FieldType<Extract<TDef[number], { readonly name: K }>["type"]>): void;
75+
76+
// get/set a field by index
77+
getIndex<I extends IndicesOf<TDef>>(index: I): FieldType<Extract<TDef[I], FieldDefinition>["type"]>;
78+
setIndex<I extends IndicesOf<TDef>>(index: I, value: FieldType<Extract<TDef[I], FieldDefinition>["type"]>): void;
79+
}
80+
81+
// Use constrained `infer` in template literal to get ordinal indices as numbers:
82+
type IndicesOf<T> = NumberFor<Extract<keyof T, string>>; // ordinal indices as number literals
83+
84+
type TypedObject<TDef extends readonly FieldDefinition[]> =
85+
& TypedObjectMembers<TDef>
86+
& TypedObjectNamedMembers<TDef>
87+
& TypedObjectOrdinalMembers<TDef>;
88+
89+
// NOTE: type would normally be created from something like `const Point = TypedObject([...])` from which we would infer the type
90+
type Point = TypedObject<[
91+
{ name: "x", type: "f64" },
92+
{ name: "y", type: "f64" },
93+
]>;
94+
95+
declare const p: Point;
96+
p.getIndex(0); // ok, 0 is a valid index
97+
p.getIndex(1); // ok, 1 is a valid index
98+
p.getIndex(2); // error, 2 is not a valid index
99+
~
100+
!!! error TS2345: Argument of type '2' is not assignable to parameter of type '0 | 1'.
101+
102+
p.setIndex(0, 0); // ok, 0 is a valid index
103+
p.setIndex(1, 0); // ok, 1 is a valid index
104+
p.setIndex(2, 3); // error, 2 is not a valid index
105+
~
106+
!!! error TS2345: Argument of type '2' is not assignable to parameter of type '0 | 1'.
107+

0 commit comments

Comments
 (0)