在此页面上,描述了生成官方文档(自动从 Chrome 存储库中生成)的过程。在同一页面上,您还可以阅读如何检索旧分支的文档。请注意,文档在某种程度上是不完整的:已弃用的 API 会立即包含在内,尽管它们仍然存在(例如onRequest
)。
What's New in Extensions是 API 更改和更新的简短列表(不包括大多数实验性 API)。它必须手动编辑,所以它并不总是最新的。例如,当前稳定版本是 20,但页面的最后一个条目是 19。
如果您确实需要包含所有 API 更改的单个页面,可以使用以下方法:
- 首先,安装所有 Chrome 版本。自动完成时这并不耗时:我编写了一个脚本来自动安装 Chrome,它复制了以前的配置文件:请参阅此答案。
- 测试特征是否存在:
- 编写一个包含所有权限的清单文件(始终忽略无法识别的权限)。
- Chrome 18+:使用清单版本 1 和 2 复制扩展程序。清单版本 1 中禁用了某些 API(示例)。
- 测试一项功能是否已实现并按预期运行是非常耗时的。因此,您最好测试 API 是否存在。
执行此操作的合理方式是递归遍历 的属性chrome
,并记录结果(显示给用户/发布到服务器)。
- 测试的过程。使用以下方法之一:
- 使用单个 Chrome 配置文件,并从最低版本开始测试。
- 为每个 Chrome 版本使用单独的配置文件,以便您可以并排测试多个 Chrome 版本。
- 后处理:解释结果。
获取信息的示例代码:
/**
* Returns a JSON-serializable object which shows all defined methods
* @param root Root, eg. chrome
* @param results Object, the result will look like {tabs:{get:'function'}}
*/
function getInfo(root, results) {
if (root == null) return results;
var keys = Object.keys(root), i, key;
results = results || {};
for (i=0; i<keys.length; i++) {
key = keys[i];
switch (typeof root[key]) {
case "function":
results[key] = 'function';
break;
case "object":
if (subtree instanceof Array) break; // Exclude arrays
var subtree = results[key] = {};
getInfo(root[key], subtree); // Recursion
break;
default:
/* Do you really want to know about primitives?
* ( Such as chrome.windows.WINDOW_ID_NONE ) */
}
}
return results;
}
/* Example: Get data, so that it can be saved for later use */
var dataToPostForLaterComparision = JSON.stringify(getInfo(chrome, {}));
// ...