使用条件属性/限制在打字稿中定义类型

Question

我是 typescript 的新手，并且已经学会了如何定义自定义类型，例如：

类型 T = {a:number, b:any}

是否可以使用类中定义的类型构造函数在 TypeScript 中为长度大于 2 的所有字符串的集合定义一个类型？

或者为所有大于 0 的数字的集合定义一个类型？

Answer 1

虽然您不能在编译时施加这种任意约束，但您可以创建强制用户调用执行这些验证的函数的类型，然后使用品牌类型在您的代码中依赖这些不变量

type PositiveNumber =  number & { positive: true}
type StringOfMinLength<T extends number> =  string & { minLegth: T}

type T = {a:PositiveNumber, b:StringOfMinLength<3> }

function isPositiveNumber(value: number): value is PositiveNumber {
    if( value < 0 ) return false
    return  true;
}
function asPositiveNumber(value: number) {
    if( !isPositiveNumber(value) ) throw new Error("Not ok")
    return value; // type guard above, value will now be a PositiveNumber 
}

function isStringOfMinLength<T extends number>(value: string, length: T): value is StringOfMinLength<T> {
    if( value.length < length ) return false;
    return true;
}

function asStringOfMinLength<T extends number>(value: string, length: T): StringOfMinLength<T> {
    if(!isStringOfMinLength(value, length) ) throw new Error("Not ok")
    return value; // type guard above, value will now be a PositiveNumber 
}

type MyData = {a:PositiveNumber, b:StringOfMinLength<3>}
let myObj: MyData = {
    a: asPositiveNumber(0),
    b: asStringOfMinLength("Test", 3),
}

Math.sqrt(myObj.a) // a will be greater then 0
myObj.b[2] // index will exist, length greater then 3

let myNotOkObject: MyData = {
    a: -1, // will be a compile error, the checking function is not called
    b: "Test" // this will also be an error event though it satisfies the constraint since we don't call the appropriate function
}

// we can also use the type guard version instead (is*) of the assertion version (as*)
let a = 10;
let b = "Test"
if(isPositiveNumber(a) && isStringOfMinLength(b, 3))
{
    let myOtherObj: MyData = { a, b } // a and b are PositiveNumber and respectively StringOfMinLength<3>
} else {
    // handle case when they are not what was expected
}

您可以在需要基本类型的任何地方使用品牌类型（例如Math.sqrt(myObj.a)），但不能将基本类型直接分配给品牌类型的字段。这在实际代码中是否有价值取决于您和您的用例。

这个article 有更多关于品牌类型的讨论。

编辑

添加了品牌类型创建函数的类型保护版本，这样您就可以检查不变量是否为真并自行处理错误情况，而不是抛出错误。 10 倍于 @AluanHaddad 的想法。