什么是'is`关键字在打字稿中做什么？

Question

我遇到了一些看起来像这样的代码:

export function foo(arg: string): arg is MyType {
    return ...
}

我无法is在文档或谷歌中搜索,这是一个非常常见的词,基本上显示在每个页面上.

关键字在该上下文中的作用是什么？

Answer 1

function isString(test: any): test is string{
    return typeof test === “string”;
}

function example(foo: any){
    if(isString(foo)){
        console.log(“it is a string” + foo);
        console.log(foo.length); // string function
    }
}
example(“hello world”);

在上面的格式中使用类型谓词"test is string"(而不是仅仅使用boolean作为返回类型),在调用isString()之后,如果函数返回true,TypeScript会将类型缩小为字符串,在任何由a保护的块中打电话给这个功能. 编译器会认为foo是以下保护块中的字符串(并且仅在以下保护块中)

{
    console.log(“it is a string” + foo);
    console.log(foo.length); // string function
}

类型谓词仅用于编译时.结果.js文件(运行时)没有区别,因为它不考虑TYPE.

我将在下面的四个例子中说明差异.

例如1:上面的示例代码不会有编译错误和运行时错误.

例如2:下面的示例代码将具有编译错误(以及运行时错误),因为TypeScript已将类型缩小为字符串并检查toExponential不属于字符串方法.

function example(foo: any){
    if(isString(foo)){
        console.log(“it is a string” + foo);
        console.log(foo.length);
        console.log(foo.toExponential(2));
    }
}

例如3:下面的示例代码没有编译错误但会有运行时错误,因为TypeScript只会将类型缩小为块中的字符串而不是后面的字符串,因此foo.toExponential不会创建编译错误(TypeScript不认为它是一个字符串类型).但是,在运行时,字符串没有toExponential方法,因此它将具有运行时错误.

function example(foo: any){
    if(isString(foo)){
        console.log(“it is a string” + foo);
        console.log(foo.length);
    }
    console.log(foo.toExponential(2));
}

例如4:如果我们不使用"test is string"(类型谓词),TypeScript将不会缩小块保护的类型,下面的示例代码将没有编译错误,但它将有运行时错误.

function isString(test: any): boolean{
    return typeof test === “string”;
}
function example(foo: any){
    if(isString(foo)){
        console.log(“it is a string” + foo);
        console.log(foo.length);
        console.log(foo.toExponential(2));
    }
}

结论是"test is string"(类型谓词)在编译时用于告诉开发人员代码将有机会出现运行时错误.对于javascript,开发人员不会在编译时知道错误.这是使用TypeScript的优势.

Answer 2

我知道的唯一用法就是您的示例之一：arg is MyType在用户定义的Type Guard中指定“ type predicate”（）

请参见本参考中的用户定义类型防护

这是另一个参考