userScripts.register() (已弃用)

语法

const registeredUserScript = await browser.userScripts.register(
  userScriptOptions       // object
);
// …
await registeredUserScript.unregister();

参数

userScriptOptions

object。表示要注册的用户脚本。其语法与 contentScripts.register() 类似。

UserScriptOptions 对象具有以下属性

scriptMetadata 可选

一个 JSON 对象，其中包含与已注册的用户脚本关联的任意元数据属性。但是，尽管是任意的，但对象必须是可序列化的，因此它与 结构化克隆算法兼容。此元数据用于将详细信息从脚本传递到 API 脚本。例如，提供需要由 API 脚本注入的 API 子集的详细信息。API 不使用此元数据。

allFrames 可选

与 content_scripts 键中的 all_frames 相同。

cookieStoreId 可选

一个 cookie 存储 ID 字符串数组或一个包含 cookie 存储 ID 的字符串。将用户脚本注册到属于这些 cookie 存储 ID 的标签页。这使得脚本可以注册到所有默认或非上下文身份的标签页、私密浏览标签页（如果 扩展程序已在私密浏览中启用）、上下文身份的标签页，或这些的组合。

excludeGlobs 可选

与 content_scripts 键中的 exclude_globs 相同。

excludeMatches 可选

与 content_scripts 键中的 exclude_matches 相同。

includeGlobs 可选

与 content_scripts 键中的 include_globs 相同。

js

对象数组。每个对象都有一个名为 file 的属性，该属性是相对于扩展程序 manifest.json 的 URL，指向要注册的 JavaScript 文件，或者有一个名为 code 的属性，其中包含要注册的 JavaScript 代码。

matchAboutBlank 可选

与 content_scripts 键中的 match_about_blank 相同。

matches

与 content_scripts 键中的 matches 相同。matches 中提供的 URL 模式必须由 manifest permission 属性中定义的宿主权限启用，或由用户从 optional_permissions 列表中启用。例如，如果 matches 包含 https://mozilla.org/a，则仅当宿主权限包含（例如）https://mozilla.org/* 时，才会注册脚本。如果 URL 模式未启用，则注册调用将因错误“Permission denied to register a user script for ORIGIN”而失败。

runAt 可选

与 content_scripts 键中的 run_at 相同。

与内容脚本选项不同，userScriptOptions 对象没有 CSS 属性。请使用 contentScripts.register() 来动态注册和注销样式表。

返回值

一个 Promise，它将使用一个 RegisteredUserScript 对象进行填充，该对象用于注销用户脚本。

浏览器兼容性

另见

• contentScripts.register()
• RegisteredUserScript.unregister()