WindowSharedStorage
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
The WindowSharedStorage interface of the Shared Storage API represents the shared storage for a particular origin within a standard browsing context.
WindowSharedStorage is accessed via Window.sharedStorage.
Instance properties
workletDeprecated-
Contains the
SharedStorageWorkletinstance representing the shared storage worklet for the current origin.SharedStorageWorkletincludes theaddModule()method, which is used to add a module to the shared storage worklet.
Instance methods
WindowSharedStorage inherits properties from its parent interface, SharedStorage.
run()Deprecated-
Executes a Run output gate operation that has been registered in a module added to the
SharedStorageWorkletof the current origin. selectURL()Deprecated-
Executes a URL Selection output gate operation that has been registered in a module added to the
SharedStorageWorkletof the current origin.
Examples
// Randomly assigns a user to a group 0 or 1
function getExperimentGroup() {
return Math.round(Math.random());
}
async function injectContent() {
// Add the module to the shared storage worklet
await window.sharedStorage.worklet.addModule("ab-testing-worklet.js");
// Assign user to a random group (0 or 1) and store it in shared storage
window.sharedStorage.set("ab-testing-group", getExperimentGroup(), {
ignoreIfPresent: true,
});
// Run the URL selection operation
const fencedFrameConfig = await window.sharedStorage.selectURL(
"ab-testing",
[
{ url: `https://your-server.example/content/default-content.html` },
{ url: `https://your-server.example/content/experiment-content-a.html` },
],
{
resolveToConfig: true,
},
);
// Render the chosen URL into a fenced frame
document.getElementById("content-slot").config = fencedFrameConfig;
}
injectContent();
See the Shared Storage API landing page for a walkthrough of this example and links to other examples.