Instructs the browser to load a script packaged in the extension, known as the API script, this script is used to export a set of custom API methods for use in user scripts. The API script path, relative to the manifest.json file, is defined as a
The API script:
- runs in the content processes.
- has access to the window and document globals related to the webpage it is attached to.
- has access to the same subset of WebExtension APIs usually available in a content script.
The script executes automatically on any webpage defined in
userScripts.register. However, this is before the user script sandbox object is created and the custom API methods can be exported.
To export the custom API methods, the script listens for
userScripts.onBeforeScript and then export the custom API methods.
Not every user script may need to consume all of the custom API methods. You can, therefore, include details of the APIs needed in
scriptMetadata when running
userScripts.register. The API script then accesses the
scriptMetadata through the
script parameter received by the
userScripts.onBeforeScript listener (as
BCD tables only load in the browser
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.