使用chrome.tabs与browser.tabs进行浏览器兼容 [英] Using chrome.tabs vs browser.tabs for browser compatibility

问题描述

我将我的Chrome扩展程序移植到Firefox。

根据MDN，有一个

最初（3周前，2016-08-25），我已经从 alarms.clear（） 至 browserAction.enable（） ，将内容从浏览器。* 移动到 chrome。* 当我在MDN上进行更改时，由于其自​​动垃圾邮件过滤而被禁用。这导致了对变化将采取的格式的讨论。我暂停了一些修改，希望一旦选择了Syntax框的中间格式，就可以一次完成初始更改。由于现实生活的双方，讨论花了比我预期的更长的时间。

看起来关于将要使用的确切格式的讨论将会扩大包含 dev-mdc邮件列表由于语法框的正确格式不适用在 Mozilla文档中介绍如何编写API方法页面。

然而，我相信我可以通过改变显示 chrome。* 而不是浏览器。* 。这样做可能会导致页面不得不再次被编辑，以使格式最终被确定为官方格式。在完成语法块格式之前，将浏览器。* 改为 chrome。* 更改可能会导致更多的整体工作，但是会在讨论格式改变的最终版本时减少混淆。虽然我必须逐页进行这些更改（有一个用于批量更改的API，但我没有访问权限），但我已经实现了一个脚本，可以完成大部分所需的更改。因此，这些最初的应该不会花太长时间。

更新：

我已更改所有WebExtensions JavaScript显示 chrome。* 而不是浏览器。* 的API页面。您可能需要在每一页上按 Ctrl - F5 以查看更改。

其他更改，更清楚地提供关于浏览器的文档。* ：

完成对语法块格式化的全面更改后，稍后还会有其他更改，它们提供了更多有关使用 chrome。* 和之间差异的API页面示例。浏览器。* 。这几乎肯定是一个较长期的项目。

I'm porting my Chrome extension to Firefox.

According to MDN there is a browser.tabs API which should be supported by chrome.

However browser is not an object in Chrome stable. At the same time chrome.tabs works just fine in Firefox.

Is it safe to replace browser with chrome when reading the MDN docs? What is the reason for the docs to write browser? Is there are planned change coming?

解决方案

Note: In the last couple days, many of the MDN JavaScript API pages have been changed from using chrome.* to using browser.* and describing the promise which is provided by the browser.* interface. Those changes make the pages not mention using the API as chrome.* at all. The changes are being made by the same person within the project with whom I had discussed the change away from browser.* to chrome.*. I do not yet know what is going on. I have sent him email asking the reason for those changes. As of this edit, 2016-11-02, it is too soon to expect a response from him.

---

I am not involved with working on the API. But, I have made, and will make, some changes to the API documentation specifically in respect to WebExtensions chrome.* vs. browser.* (all pages were changed to show chrome.* as of 2016-09-22). I got involved because I, also, found having most of the WebExtensions API pages show browser.* confusing. I wanted to know what the difference was between chrome.* and browser.*. Once I found out, I wanted to make it less confusing for others.

The WebExtensions browser.* API returns a promise:

The browser.* object implements a version of the API that returns a promise if you omit providing a callback function when you call the API. The intent is that the actual functionality is the same for both chrome.* and browser.*. If you provide a callback function to the browser.* API, it functions identically to the chrome.* API.

Is it safe to replace browser with chrome when reading the MDN docs?

Yes, unless the documentation is specifically discussing promises. The only difference between the two is that the browser.* methods will return a promise if the callback function is not provided when you call the API.

What is the reason for the docs to write browser?

I'm not sure as to why the docs were originally written with browser.* being so prominent. I assume that either it was a configuration choice that was made when the pages were generated, or the specifics of the difference between chrome.* and browser.* changed at some point early in implementing the WebExtensions API.

Is there a technical reason why chrome.* without a callback can't return a promise?

The only reason I have come up with so far is that using chrome.* to return promises would make it impossible to check for the presence of a mandatory callback function when performing parameter checking within the API. With the browser.* namespace, the API can assume the caller is using the returned promise. Thus, with browser.* a promise can be returned rather than generating an error when a mandatory callback function is not provided in the call to the API. This reason is, however, speculation on my part.

Changing the documentation:

I agree that having the API documentation primarily show browser.* in the Syntax section and elsewhere in each API page is confusing (e.g. in examples). I have been discussing changing this across the entire API documentation with the person primarily in charge of the WebExtensions documentation for the last 3 weeks. He agrees that it should be changed.

There are plans to make the change. The documentation will change in at least two phases. The first will be to go through all the WebExtensions API pages and change the Syntax section to say chrome.*. A note at the end of the Syntax section will say that the "API is also available as browser.* in a version that returns a promise." In addition, all usage of browser.* throughout the page will be changed to chrome.* except those portions which are specifically showing the API being used as returning a promise.

The current expectation is that the page will look much like alarms.clear() does now. I had changed that page to show what I was suggesting the change will be, including suggestions from the person in charge of the WebExtensions documentation. The alarms.clear() Syntax section currently looks like:

Initially (3 weeks ago, 2016-08-25), I had changed the API pages from alarms.clear() through browserAction.enable() with the primary change of moving the content from saying browser.* to chrome.* when my access to making changes on MDN was disabled due to their automatic SPAM filtering. This lead to the discussion of the format that the changes will take. I paused making changes with the hope that making the initial changes could be done in one pass once the intermediate format for the Syntax box was chosen. Due to real life, on both sides, the discussion has taken longer than I expected.

It looks like the discussion about the exact format which will be used is going to broaden to include the dev-mdc mailing list due to the "correct" format for Syntax boxes not being clear in the Mozilla documentation for how to write an API method page.

However, I believe I can move forward with making the change of showing chrome.* instead of browser.*. Doing so will probably result in the pages having to be edited again to get the format to whatever is eventually decided as the official formatting. Making the browser.* to chrome.* change prior to finalizing the Syntax block format will probably result in more overall work, but will reduce confusion while the final version of the format change is discussed. While I have to make these changes on a page by page basis (there is an API for making bulk changes, but I do not have access), I have already implemented a script that makes the majority of the needed changes. Thus, these initial ones should not take too long.

Update:
I have changed all of the WebExtensions JavaScript API pages to show chrome.* instead of browser.*. You may need to press Ctrl-F5 on each page to see the changes.

Further changes, more clearly providing documentation on browser.*:
After the full changes to Syntax block formatting are made, there is an desire that there be additional changes, at a later time, that provide more examples on a per-API-page basis of the differences between using chrome.* and browser.*. This is almost certainly a longer term project.

这篇关于使用chrome.tabs与browser.tabs进行浏览器兼容的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！