WindowSharedStorage: run()-Methode
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.
Die run()
-Methode des WindowSharedStorage
-Interfaces führt eine run-Operation aus, die in einem Modul registriert ist, das dem aktuellen Ursprung des SharedStorageWorklet
hinzugefügt wurde.
Hinweis: Das Run Output Gate ist als generische Methode zur Verarbeitung einiger gemeinsamer Speicherdaten gedacht.
Syntax
run(name)
run(name, options)
Parameter
name
-
Ein String, der den registrierten Namen der Operation innerhalb des Shared-Storage-Worklet-Moduls darstellt. Er muss mit dem bei der Registrierung mit
SharedStorageWorkletGlobalScope.register()
angegebenen Namen übereinstimmen. options
Optional-
Ein Optionen-Objekt, das die folgenden Eigenschaften enthalten kann:
data
Optional-
Ein Objekt, das alle Daten darstellt, die zur Ausführung der Operation erforderlich sind.
keepAlive
Optional-
Ein boolescher Wert. Wenn auf
true
gesetzt, bleibt derSharedStorageWorkletGlobalScope
des zugehörigen Worklets aktiv, und die Operation kann erneut ausgeführt werden. Daher müssen SiekeepAlive
auftrue
setzen für jede Operation, die nicht die letzte sein soll. Der Standardwertfalse
bedeutet, dass derSharedStorageWorkletGlobalScope
nach Ausführung der Operation beendet wird und nicht erneut ausgeführt werden kann.
Rückgabewert
Ein Promise
, das sich mit undefined
erfüllt.
Ausnahmen
TypeError
-
Wird ausgelöst, 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 Anmeldeprozess der Datenschutzerweiterung eingeschlossen hat.
- Das Worklet-Modul noch nicht mit
Beispiele
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 Eindeutige Reichweitenmessung für eine vollständige Erklärung dieses Beispiels. Weitere Beispiele finden Sie in der Shared Storage API.
Spezifikationen
Specification |
---|
Shared Storage API # dom-windowsharedstorage-run |
Browser-Kompatibilität
BCD tables only load in the browser