WindowSharedStorage:run() 方法

实验性: 这是一项 实验性技术
在生产环境中使用此功能之前,请仔细查看 浏览器兼容性表

run()WindowSharedStorage 接口的方法,它执行在添加到当前来源的 SharedStorageWorklet 中的模块中注册的 运行操作

注意: 运行输出门 旨在作为一种通用的方法来处理一些共享存储数据。

语法

js
run(name)
run(name, options)

参数

name

一个字符串,表示在共享存储 worklet 模块中注册的操作的名称。它必须与使用 SharedStorageWorkletGlobalScope.register() 注册操作时提供的名称一致。

options 可选

一个选项对象,可以包含以下属性

data 可选

一个对象,表示执行操作所需的任何数据。

keepAlive 可选

一个布尔值。如果设置为 true,则关联 worklet 的 SharedStorageWorkletGlobalScope 将保持活动状态,并且可以再次运行该操作。因此,对于每个不打算作为最后一个操作的操作,您都需要将 keepAlive 设置为 true。默认值 false 意味着在运行操作后,SharedStorageWorkletGlobalScope 将终止,并且不能再次运行。

返回值

一个 Promise,它将以 undefined 作为结果。

异常

TypeError

抛出异常的情况:

  • 尚未使用 addModule() 添加 worklet 模块。
  • 共享存储已禁用(例如通过浏览器设置)。
  • 调用站点在成功的 隐私沙箱注册流程 中没有包含共享存储 API。

示例

js
async function measureUniqueReach() {
  // Load the Shared Storage worklet
  await window.sharedStorage.worklet.addModule("reach-measurement-worklet.js");

  // Run the reach measurement operation
  await window.sharedStorage.run("reach-measurement", {
    data: { contentId: "1234" },
  });
}

measureUniqueReach();

有关此示例的完整说明,请参阅 唯一覆盖范围测量。有关更多示例,请参阅 共享存储 API

规范

规范
共享存储 API
# dom-windowsharedstorage-run

浏览器兼容性

BCD 表仅在浏览器中加载

另请参阅