userScripts.configureWorld()
Configures USER_SCRIPT execution environments for the extension.
Changes to world configurations only apply to new instances of the world: A configuration won't apply to a world initialized by the execution of a user script in a document until the document is reloaded. However, the browser may revoke certain privileges when a configuration is updated. For example, message calls from a USER_SCRIPT world may fail if the extension sets messaging to false.
World configurations persist until the extension is updated or the configuration is reset by userScripts.resetWorldConfiguration().
Syntax
let configuredWorld = browser.userScripts.configureWorld(
properties // object
);
Parameters
properties-
userScripts.WorldProperties. Details of the configuration for aUSER_SCRIPTworld.When
worldIdis omitted or the string is empty, the update is applied to the default world and all worlds without an explicit configuration. WhenworldIdis specified only that world is configured.When updating the default world and worlds without an explicit configuration, when properties are omitted the
userScripts.WorldPropertiesdefaults are used.
Return value
A Promise fulfilled with no arguments if the request is successful. If the request fails, the promise is rejected with an error message.
Example extensions
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
configureWorld
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support