Documentation: Chrome User Scripts API
A promise-based wrapper around the Chrome userScripts API. Note: This API is available in Manifest V3.
- configureUserScriptsWorld(properties?)
- getUserScripts(ids?)
- getUserScriptsWorldConfigs()
- executeUserScript(injection)
- registerUserScripts(scripts)
- resetUserScriptsWorldConfigs(worldId?)
- unregisterUserScripts(ids?)
- updateUserScripts(scripts)
- isAvailableUserScripts()
configureUserScriptsWorld(properties?: chrome.userScripts.WorldProperties): Promise<void>
Configures the execution world for user scripts. If properties is omitted, defaults are used.
getUserScripts(ids?: string[]): Promise<chrome.userScripts.RegisteredUserScript[]>
Retrieves registered user scripts. When ids is provided, returns only scripts with matching IDs.
getUserScriptsWorldConfigs(): Promise<chrome.userScripts.WorldProperties[]>
Returns the currently configured user script worlds.
executeUserScript(injection: chrome.userScripts.UserScriptInjection): Promise<chrome.userScripts.InjectionResult[]>
Executes a user script with the provided injection parameters and resolves with the results from all frames where it executed.
registerUserScripts(scripts: chrome.userScripts.RegisteredUserScript[]): Promise<void>
Registers one or more user scripts.
resetUserScriptsWorldConfigs(worldId?: string): Promise<void>
Resets the configuration of a specific world by ID, or all worlds if worldId is omitted.
unregisterUserScripts(ids?: string[]): Promise<void>
Unregisters user scripts. When ids are provided, only scripts with those IDs are removed; otherwise, all registered scripts are removed.
updateUserScripts(scripts: chrome.userScripts.RegisteredUserScript[]): Promise<void>
Updates previously registered user scripts with new definitions.
isAvailableUserScripts(): boolean
Returns true if the chrome.userScripts API is available in the current environment (typically Manifest V3), otherwise false.