谷歌闭包编译器类型注释数组

Google Closure Compiler type annotations for array

本文关键字：注释 数组 类型 编译器 闭包 谷歌      更新时间：2023-09-26

在使用Google Closure Compiler时，我发现无法强制编译器对错误的变量类型发出警告。我使用了以下示例:

/** @typedef ({name: string, token: string}) */
var pendingItem;
/** @type (Array.<pendingItem>) */
var pending = [];
// NOTICE: the token is intentionally misspelled as "toke" to cause a warning
var dummyItem = {
  name: 'NameHere',
  toke: 'SomeToken' 
};
// This should cause a warning, because of the 
// type mismatch (toke instead of token)
pending.push(dummyItem);
// Do something useful so that the whole code wouldn't be optimized to 0 bytes
alert(pending.length);

它可以完美地编译，而不是给出预期的类型警告。但是如果你使用:

pending[1] = {
  name: 'Second Name',
  toke: 'Second Token'
}

得到预期的类型不匹配警告。

我理解这可能是因为push没有定义类型检查，因为它是一个内置函数。可以预期，将pending定义为pendingItem的数组将强制这样做，但默认情况下不会这样做。

问题是是否以及如何可能向已经定义的函数(如push)添加类型检查，以便在上面的示例中给出警告。我也明白，实现类似结果的一种方法是在dummyItem之前添加/** @type {pendingItem} */来强制类型，但出于教育目的，我想知道如何为push这样的函数添加类型检查(或者可能更严格地定义pending本身)。

还有谁能解释一下重命名对象属性背后的逻辑是什么?如果您编译上面的示例，它不会将dummyItem的属性重命名为name，但会将token重命名为a。

要强制对push进行类型检查，必须在代码中使用正确的类型重新定义它。注意，使用对象文字表示法时，必须使用@type而不是@param来定义类型，因为我们将函数赋值给对象的形参，而不是定义普通函数。在这种情况下，它将是如下:

/** @type {function(pendingItem)} */
pending.push = function(item) {
  Array.prototype.push.call(pending, item);
};

现在当尝试编译以下内容时:

// Still an intentionally misspelled "toke"
var dummyItem = {
  name: 'NameHere',
  toke: 'SomeToken' 
};
// First warning
pending.push(dummyItem);
// Second warning
pending[1] = {
  name: 'Second name',
  toke: 'Second Token'
};

则两者都将生成类型不匹配警告，如预期的那样。

觉得将来可能对某个人有用。

相关文章：