T
in setNumberField
是一个黑匣子。没有人知道,甚至你,是否T
是否有带数值的键。没有适当的约束。setNumberField
允许您提供原始值作为第一个参数。这意味着在函数体内,TS 不知道item[field]
始终是一个数值。然而,TS 在函数调用期间意识到了这一点。所以函数有两个级别的类型。一 - 是函数定义,当 TS 无法猜测时T
类型和第二个 - 在函数调用期间,当 TS 知道时T
类型并能够推断它。
最简单的方法就是避免突变。您可以返回新对象。
考虑这个例子:
type TestType = {
a: number,
b?: number,
c: string,
d: number
}
type StringKeysMatchingNumber<T> = {
[K in keyof T]-?: K extends string ?
T[K] extends number ?
K
: never
: never
}[keyof T];
const setNumberField = <
Item,
Field extends StringKeysMatchingNumber<Item>
>(item: Item, field: Field): Item => ({
...item,
[field]: 1
})
declare let foo: TestType
// {
// a: number;
// b: string;
// }
const result = setNumberField({ a: 42, b: 'str' }, 'a')
操场
请记住,TypeScript 不喜欢突变。看我的article
如果你仍然想改变你的参数,你应该重载你的函数。
type TestType = {
a: number,
b?: number,
c: string,
d: number
}
type StringKeysMatchingNumber<T> = {
[K in keyof T]-?: K extends string ?
T[K] extends number ?
K
: never
: never
}[keyof T];
function setNumberField<Item, Field extends StringKeysMatchingNumber<Item>>(item: Item, field: Field): void;
function setNumberField(item: Record<string, number>, field: string): void {
item[field] = 2
}
declare let foo: TestType
const result1 = setNumberField({ a: 42, b: 'str' }, 'a') // ok
const result2 = setNumberField({ a: 42, b: 'str' }, 'b') // expected error
操场
函数重载并不那么严格。您可能已经注意到,这个函数类型定义function setNumberField(item: Record<string, number>, field: string)
允许您仅使用所有值都是数字的对象。但这种情况并非如此。这就是为什么我用另一层重载了这个函数。最下面的一个用于函数体。最上面的一张,带有StringKeysMatchingNumber
控制函数参数。
UPDATE
为什么要添加约束,例如T extends Record<string, number>
是
不足以让 TS 知道其类型item[field]
考虑一下:
type StringKeysMatchingNumber<T> = {
[K in keyof T]-?: K extends string ?
T[K] extends number ? // This line does not mean that T[K] is equal to number
K
: never
: never
}[keyof T];
这条线T[K] extends number
意思是T[K]
是数字的子类型。有可能number & {__tag:'Batman'}
。另外,请记住,StringKeysMatchingNumber
可能会回来never
并且编号不可分配给never
:
declare let x: never;
x = 1 // error
请注意,那个呼唤StringKeysMatchingNumber
与静态参数一样{foo: 42}
产生预期结果"foo"
:
type Result = StringKeysMatchingNumber<{ foo: 42 }> // foo
但解决StringKeysMatchingNumber
函数体内部是完全不同的历史。将鼠标悬停在Result
内部函数
参见示例:
function setNumberField<
T extends Record<string, number>,
Field extends StringKeysMatchingNumber<T>
>(item: T, field: Field) {
type Result = StringKeysMatchingNumber<T> // resolving T inside a function
const value = item[field];
item[field] = 1; // error
value.toExponential // ok
}
item[field]
决心T[Field]
,它不是一个number
类型。它是一个子类型number
类型。您仍然可以致电toExponential
。了解这一点非常重要item[field]
是一种具有以下所有属性的类型number
类型,但也可能包含一些其他属性。number
从 TS 的角度来看并不原始。
//"toString" | "toFixed" | "toExponential" | "toPrecision" | "valueOf" | "toLocaleString"
type NumberKeys = keyof number
看看这个:
function setNumberField<
T extends Record<string, number>,
Field extends StringKeysMatchingNumber<T>
>(item: T, field: Field) {
let numSupertype = 5;
let numSubtype = item[field]
numSupertype = numSubtype // ok
numSubtype = numSupertype // expected error
}
numSubtype
可分配给numSupertype
. item[field]
可分配给任何变量number
键入而number
不可分配给item[field]
.
最后一个问题是您想要分配号码的方式item[field]
类型足够安全吗?
type StringKeysMatchingNumber<T> = {
[K in keyof T]-?: T[K] extends number ? K : never
}[keyof T];
function setNumberField<
T extends Record<string, number>,
Field extends StringKeysMatchingNumber<T>
>(item: T, field: Field) {
item[field] = 2
}
type BrandNumber = number & { __tag: 'Batman' }
declare let brandNumber: BrandNumber
type WeirdDictionary = Record<string, BrandNumber>
const obj: WeirdDictionary = {
property: brandNumber
}
setNumberField(obj, 'foo')
setNumberField
需要一个字典,其中每个值都扩展number
类型。这意味着价值可能是number & { __tag: 'Batman' }
。我知道,从开发人员的角度来看这很奇怪,但从类型的角度来看却并不奇怪。它只是一个子类型number
该技术用于模拟名义类型。
如果您分配会发生什么2
to item[field]
没有错误?调用此函数后,您期望每个值是BrandNumber
但这不会是真的。
所以,TypeScript 在这里做得很好:D
您可以在我的文章中找到有关函数参数推断的更多信息article