SharedStorage: set() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
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 set() method of the SharedStorage interface either stores a new key-value pair in the current origin's shared storage or updates an existing one.
Syntax
set(key, value)
set(key, value, options)
Parameters
key-
A string representing the key in the key-value pair that you want to add or update.
value-
A string representing the value you want to add or update.
optionsOptional-
An options object containing the following properties:
ignoreIfPresent-
A boolean value. The value
truecauses the set operation to abort if a key-value pair with the specifiedkeyalready exists. The default valuefalsecauses the set operation to overwrite the previous value.
Return value
A Promise that fulfills with undefined.
Exceptions
- The
Promiserejects with aTypeErrorif:- The created entry was not successfully stored in the database due to shared storage not being available (for example it is disabled using a browser setting).
keyand/orvalueexceed the browser-defined maximum length.- The calling site does not have the Shared Storage API included in a successful privacy sandbox enrollment process.
- In the case of
WorkletSharedStorage, thePromiserejects with aTypeErrorif the worklet module has not been added withSharedStorageWorklet.addModule().
Note:
In the case of WindowSharedStorage, if the set() operation doesn't successfully write to the database for a reason other than shared storage not being available, no error is thrown — the operation still fulfills with undefined.
Examples
window.sharedStorage
.set("ab-testing-group", "0", {
ignoreIfPresent: true,
})
.then(() => console.log("Set operation completed"));
Specifications
| Specification |
|---|
| Shared Storage API # dom-sharedstorage-set |