UserScripts.UserScriptOptions

The UserScriptOptions object represents the content scripts to register. It has similar syntax to the contentScript options supported by browser.contentScripts.register. The differences are:

  • it does not support a css property (use browser.contentScripts.register to dynamically register/unregister stylesheets)
  • It does support an optional scriptMetadata property (as a plain JSON object which contains some metadata properties associated to the registered userScripts)

The UserScriptOptions object has the following properties:

allFramesOptional
Same as all_frames in the content_scripts key.
excludeGlobsOptional
Same as exclude_globs in the content_scripts key.
excludeMatchesOptional
Same as exclude_matches in the content_scripts key.
includeGlobsOptional
Same as include_globs in the content_scripts key.
jsOptional
An array of objects. Each object has either a property named file, which is a URL starting at the extension's manifest.json and pointing to a JavaScript file to register, or a property named code, which is some JavaScript code to register.
matchAboutBlankOptional
Same as match_about_blank in the content_scripts key.
matches
Same as matches in the content_scripts key.
runAtOptional
Same as run_at in the content_scripts key.
scriptMetadata Optional
A user script metadata value

It has similar syntax to the contentScript options supported by browser.contentScripts.register.