SharedStorage: set() method
Deprecated
To be removed
This feature is pending removal from browsers. Using it now may lead to broken functionality in future updates. Following the announcement that Chrome will maintain its current approach to third-party cookies, Chrome decided to withdraw certain Privacy Sandbox features including the shared storage.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
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"));