美文网首页让前端飞
TypeScript——JavaScript文件类型检查(一)

TypeScript——JavaScript文件类型检查(一)

作者: 2o壹9 | 来源:发表于2019-12-27 10:39 被阅读0次

TypeScript 2.3以后的版本支持使用--checkJs对.js文件进行类型检查和错误提示。

你可以通过添加// @ts-nocheck注释来忽略类型检查;相反,你可以通过去掉--checkJs设置并添加一个// @ts-check注释来选则检查某些.js文件。 你还可以使用// @ts-ignore来忽略本行的错误。 如果你使用了tsconfig.json,JS检查将遵照一些严格检查标记,如noImplicitAny,strictNullChecks等。 但因为JS检查是相对宽松的,在使用严格标记时可能会有些出乎意料的情况。

对比.js文件和.ts文件在类型检查上的差异,有如下几点需要注意:

用JSDoc类型表示类型信息

.js文件里,类型可以和在.ts文件里一样被推断出来。 同样地,当类型不能被推断时,它们可以通过JSDoc来指定,就好比在.ts文件里那样。 如同TypeScript,--noImplicitAny会在编译器无法推断类型的位置报错。 (除了对象字面量的情况;后面会详细介绍)

JSDoc注解修饰的声明会被设置为这个声明的类型。比如:

/** @type {number} */

var x;

x = 0;      // OK

x = false;  // Error: boolean is not assignable to number

你可以在这里找到所有JSDoc支持的模式,JSDoc文档。

属性的推断来自于类内的赋值语句

ES2015没提供声明类属性的方法。属性是动态赋值的,就像对象字面量一样。

在.js文件里,编译器从类内部的属性赋值语句来推断属性类型。 属性的类型是在构造函数里赋的值的类型,除非它没在构造函数里定义或者在构造函数里是undefined或null。 若是这种情况,类型将会是所有赋的值的类型的联合类型。 在构造函数里定义的属性会被认为是一直存在的,然而那些在方法,存取器里定义的属性被当成可选的。

class C {

    constructor() {

        this.constructorOnly = 0

        this.constructorUnknown = undefined

    }

    method() {

        this.constructorOnly = false // error, constructorOnly is a number

        this.constructorUnknown = "plunkbat" // ok, constructorUnknown is string | undefined

        this.methodOnly = 'ok'  // ok, but y could also be undefined

    }

    method2() {

        this.methodOnly = true  // also, ok, y's type is string | boolean | undefined

    }

}

如果一个属性从没在类内设置过,它们会被当成未知的。

如果类的属性只是读取用的,那么就在构造函数里用JSDoc声明它的类型。 如果它稍后会被初始化,你甚至都不需要在构造函数里给它赋值:

class C {

    constructor() {

        /** @type {number | undefined} */

        this.prop = undefined;

        /** @type {number | undefined} */

        this.count;

    }

}

let c = new C();

c.prop = 0;          // OK

c.count = "string";  // Error: string is not assignable to number|undefined

构造函数等同于类

ES2015以前,Javascript使用构造函数代替类。 编译器支持这种模式并能够将构造函数识别为ES2015的类。 属性类型推断机制和上面介绍的一致。

function C() {

    this.constructorOnly = 0

    this.constructorUnknown = undefined

}

C.prototype.method = function() {

    this.constructorOnly = false // error

    this.constructorUnknown = "plunkbat" // OK, the type is string | undefined

}

支持CommonJS模块

在.js文件里,TypeScript能识别出CommonJS模块。 对exports和module.exports的赋值被识别为导出声明。 相似地,require函数调用被识别为模块导入。例如:

// same as `import module "fs"`

const fs = require("fs");

// same as `export function readFile`

module.exports.readFile = function(f) {

  return fs.readFileSync(f);

}

对JavaScript文件里模块语法的支持比在TypeScript里宽泛多了。 大部分的赋值和声明方式都是允许的。

类,函数和对象字面量是命名空间

.js文件里的类是命名空间。 它可以用于嵌套类,比如:

class C {

}

C.D = class {

}

ES2015之前的代码,它可以用来模拟静态方法:

function Outer() {

  this.y = 2

}

Outer.Inner = function() {

  this.yy = 2

}

它还可以用于创建简单的命名空间:

var ns = {}

ns.C = class {

}

ns.func = function() {

}

同时还支持其它的变化:

// 立即调用的函数表达式

var ns = (function (n) {

  return n || {};

})();

ns.CONST = 1

// defaulting to global

var assign = assign || function() {

  // code goes here

}

assign.extra = 1

对象字面量是开放的

.ts文件里,用对象字面量初始化一个变量的同时也给它声明了类型。 新的成员不能再被添加到对象字面量中。 这个规则在.js文件里被放宽了;对象字面量具有开放的类型,允许添加并访问原先没有定义的属性。例如:

var obj = { a: 1 };

obj.b = 2;  // Allowed

对象字面量的表现就好比具有一个默认的索引签名[x:string]: any,它们可以被当成开放的映射而不是封闭的对象。

与其它JS检查行为相似,这种行为可以通过指定JSDoc类型来改变,例如:

/** @type {{a: number}} */

var obj = { a: 1 };

obj.b = 2;  // Error, type {a: number} does not have property b

null,undefined,和空数组的类型是any或any[]

任何用null,undefined初始化的变量,参数或属性,它们的类型是any,就算是在严格null检查模式下。 任何用[]初始化的变量,参数或属性,它们的类型是any[],就算是在严格null检查模式下。 唯一的例外是像上面那样有多个初始化器的属性。

function Foo(i = null) {

    if (!i) i = 1;

    var j = undefined;

    j = 2;

    this.l = [];

}

var foo = new Foo();

foo.l.push(foo.i);

foo.l.push("end");

函数参数是默认可选的

由于在ES2015之前无法指定可选参数,因此.js文件里所有函数参数都被当做是可选的。 使用比预期少的参数调用函数是允许的。

需要注意的一点是,使用过多的参数调用函数会得到一个错误。

例如:

function bar(a, b) {

  console.log(a + " " + b);

}

bar(1);      // OK, second argument considered optional

bar(1, 2);

bar(1, 2, 3); // Error, too many arguments

使用JSDoc注解的函数会被从这条规则里移除。 使用JSDoc可选参数语法来表示可选性。比如:

/**

* @param {string} [somebody] - Somebody's name.

*/

function sayHello(somebody) {

    if (!somebody) {

        somebody = 'John Doe';

    }

    console.log('Hello ' + somebody);

}

sayHello();

相关文章

网友评论

    本文标题:TypeScript——JavaScript文件类型检查(一)

    本文链接:https://www.haomeiwen.com/subject/lxnroctx.html