WindowSharedStorage: run() Methode

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die run()-Methode des WindowSharedStorage-Interfaces führt eine Run-Operation aus, die in einem Modul registriert ist, das dem SharedStorageWorklet des aktuellen Ursprungs hinzugefügt wurde.

Hinweis: Das Ausgabe-Gate der Ausführung ist als generische Methode zur Verarbeitung einiger gemeinsamer Speicherungsdaten gedacht.

Syntax

js
run(name)
run(name, options)

Parameter

name

Ein String, der den Namen der registrierten Operation innerhalb des Shared Storage Worklet-Moduls darstellt. Er muss mit dem Namen übereinstimmen, der der Operation gegeben wurde, als sie mit SharedStorageWorkletGlobalScope.register() registriert wurde.

options Optional

Ein Optionsobjekt, das die folgenden Eigenschaften enthalten kann:

data Optional

Ein Objekt, das alle Daten repräsentiert, die für die Ausführung der Operation erforderlich sind.

keepAlive Optional

Ein boolescher Wert. Wenn auf true gesetzt, bleibt der SharedStorageWorkletGlobalScope des zugehörigen Worklets aktiv, und die Operation kann erneut ausgeführt werden. Daher muss keepAlive für jede Operation, die nicht die letzte sein soll, auf true gesetzt werden. Der Standardwert false bedeutet, dass der SharedStorageWorkletGlobalScope nach der Ausführung der Operation beendet wird und nicht erneut ausgeführt werden kann.

Rückgabewert

Ein Promise, das mit undefined erfüllt wird.

Ausnahmen

TypeError

Wird geworfen, wenn:

  • Das Worklet-Modul noch nicht mit addModule() hinzugefügt wurde.
  • Der gemeinsame Speicher deaktiviert ist (zum Beispiel über eine Browsereinstellung).
  • Die aufrufende Seite die Shared Storage API nicht in einem erfolgreichen Privacy Sandbox-Einschreibungsprozess enthalten hat.

Beispiele

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();

Siehe Messung der einzigartigen Reichweite für eine vollständige Erklärung dieses Beispiels. Weitere Beispiele finden Sie in der Shared Storage API.

Spezifikationen

No specification found

No specification data found for api.WindowSharedStorage.run.
Check for problems with this page or contribute a missing spec_url to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.

Browser-Kompatibilität

Siehe auch