userScripts.configureWorld()

为扩展配置USER_SCRIPT的执行环境。

对世界配置的更改仅适用于世界的新实例:在文档重新加载之前,配置不会应用于通过用户脚本执行而初始化的世界。但是,当配置更新时,浏览器可能会撤销某些特权。例如,如果扩展将messaging设置为false,则来自USER_SCRIPT世界的消息调用可能会失败。

世界配置会一直保留,直到扩展程序更新或通过 userScripts.resetWorldConfiguration() 重置配置。

语法

js
let configuredWorld = browser.userScripts.configureWorld(
  properties       // object
);

参数

properties

userScripts.WorldPropertiesUSER_SCRIPT世界配置的详细信息。

当省略worldId或字符串为空时,更新将应用于默认世界以及所有没有显式配置的世界。当指定worldId时,则仅配置该世界。

更新默认世界和没有显式配置的世界时,如果省略了属性,将使用 userScripts.WorldProperties 的默认值。

返回值

如果请求成功,则返回一个不带参数的已解析 Promise。如果请求失败,则返回一个带有错误消息的拒绝的 Promise。

扩展程序示例

浏览器兼容性