userScripts.RegisteredUserScript
An object representing registered user scripts. Returned by userScripts.getScripts()
and used as input to userScripts.register()
and userScripts.update()
.
Type
Values of this type are an object containing these properties:
allFrames
Optional-
boolean
. IfallFrames
istrue
, the script is injected into all of a page's frames. By default, it'sfalse
and the script is only injected into the top frame. id
-
string
. The ID of a user script. This property must not start with a '_', which is reserved as a prefix for generated script IDs. js
Optional foruserScripts.update()
calls, required foruserScripts.register()
-
array
ofuserScripts.ScriptSource
. The scripts to inject into matching pages. matches
Optional-
array
ofstring
. Match patterns for the pages to run the script in.matches
orincludeGlobs
must be specified inuserScripts.register()
calls. excludeMatches
Optional-
array
ofstring
. Match patterns for pages that the script must not be run in. includeGlobs
Optional-
string
. Glob patterns for the pages to run the script in.matches
orincludeGlobs
must be specified inuserScripts.register()
calls. excludeGlobs
Optional-
string
. Glob patterns for pages that the script must not be run in. runAt
Optional-
extensionTypes.RunAt
. The earliest the script is injected into a tab. Defaults to"document_idle"
. world
Optional-
userScripts.ExecutionWorld
. The execution environment to use to run the scripts. Defaults to"USER_SCRIPT"
. worldId
Optional-
string
. ID of a user script world the script executes in. Only valid ifworld
isUSER_SCRIPT
or omitted. IfworldId
is omitted, the script is executed in the defaultUSER_SCRIPT
world (""). Values with leading underscores (_
) are reserved. The maximum length is 256 characters. A world can be used by several scripts as their execution environment. To configure the behavior of a world, pass itsworldId
touserScripts.configureWorld
before the first script executes in that world.