详解Anyscript开发指南绕过typescript类型检查

前言

场景设定

解决方法

注释忽略

场景用例

类型断言

场景用例

泛型转换

场景用例

总结

前言

随着越来越多的前端项目采用 typescript 来开发，越来越多前端开发者会接触、使用这门语言。它是前端项目工程化的一个重要帮手，结合 vscode 编辑器，给予了前端开发者更严谨、高效的编码体验。但同时，严格的类型检查也会使部分开发者的编码效率有所降低，将时间花费在解决类型冲突、类型不匹配上，从而导致望而却步，迟迟不敢上手。

本文描述了几种绕过 typescript 类型检查的方法，帮助ts开发者在遇上第三方库类型声明有误、上线时间紧张却还被ts类型耽搁开发进度、以及其他奇奇怪怪ts类型声明的场景时，能够快速摆脱ts类型检测，保障项目尽快上线。

注意，本文所提到的方法，只能作为一种最后不得已的hack手段，其目的是为了尽快完成需求而非代码取巧，读者不应该将其当成一种常用的写法并在项目内任意使用！

场景设定

假设存在一个第三方库，允许开发者通过 json 定义一个表单，其 typescript 类型定义如下：

interface FormItem{
    /** 表单类型 */
    type:string
    /** 显示文本 */
    label:string
}
interface FormSelectItem extends FormItem{  
    /** 将表单类型指定为'select' */
    type:'select'
    /** 新增一个options属性，类型为数组，此类型定义存在错误，没有定义options数组里面的内容 */
    options:[]
}
type FormRule = (FormSelectItem|FormItem)[]

代码里，FormSelectItem.options期望的是一个有内容的数组，但因为第三方库给定的类型文件编写错误，没有给出数组内部项的结构，只留下[]空数组类型定义，导致开发者给FormSelectItem.options赋予一个有内容的数组都会导致 typescript 报错。

解决方法 注释忽略

//@ts-ignore会让typescript编译器跳过注释下一行代码，不对其进行类型检查。通过不检查类型的方式，绕过类型检查

//@ts-ignore
window.aaaa = "使用示例（ts里不允许通过此行代码往全局对象挂载属性）"

场景用例

加上//@ts-ignore在options属性之上，编译器跳过了options属性的检查，因此报错消失。使用起来十分简单快捷，但是加了注释忽略之后，开发者为options赋予任何值都是合法的，如非数组的对象、null、undefined等容易引起程序出错的类型。同时加了//@ts-ignore之后，编辑器无法再对此行进行代码提示和自动补全。

类型断言

类型断言是typescript中一种将一个类型指定为另一个类型的语法。通过指定任意类型为目标类型的方式，达到编译器不报错的效果。

(window as unknown as {aaa:string}).aaa = "使用示例（ts里不允许通过此行代码往全局对象挂载属性）"

场景用例

上图使用了断言语法，且用到两种断言方式：

第一种写法是给赋值数据下断言，将数据类型强制断言为定义类型，即在上图中，将{label:string,value:string}[]断言为[]，使得能够与options 的类型匹配上。在属性赋值中只能使用此种断言写法。

第二种写法是反过来，通过将定义类型强制断言为数据类型，即在上图中，将[]断言为{label:string,value:string}[]，使得select.options能够按照开发者的数据类型进行工作。并且通过此种方式，对select.options进行操作时，编辑器还会根据开发者的断言类型进行语法提示。

相比注释忽略，类型断言原本就是typescript语法的一部分，本身就会接受类型检查，因此后续的代码补全提示功能是完整的。但同时开发者主观上应当明白类型断言的作用，避免将不正确的数据类型传入导致代码出错。

泛型转换

泛型是typescript最强大的功能，它提供给了开发者们对类型“编程”的能力。通过定义泛型辅助函数，在类型断言的基础上，利用函数返回泛型的手段，巧妙地将类型匹配上，从而达到缩小代码量且编译器不报错的效果。

function _any<T>(obj:any):T{
    return obj as unknown as T
}
_any<{aaa:string}>(window).aaa='使用示例（ts里不允许通过此行代码往全局对象挂载属性）'

实际上，辅助函数也只是将参数当作是返回值而已，只不过利用泛型可以指定为任意类型。

甚至可以设置两个泛型：一个是目标泛型，也就是函数要返回的数据类型，一个是参数泛型，也就是传入的数据类型。当显式地赋予泛型P一个类型时，typescript可以为参数提供类型检查和语法补全。

function _any<T,P=any>(obj:P):T{
    return obj as unknown as T
}
const select:FormSelectItem = {
    type:'select',
    options:_any<[],{label:string,value:string}[]>([{
        label:'',
        value:''
    }])
}
_any<{label:string,value:string}[]>(select.options).push({
    label:'',
    value:''
})

场景用例