Shared Storage API
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.
options- : 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.
- : A boolean value. The value
- : An options object containing the following properties:
Return value
A Promise that fulfills with undefined.
Exceptions
- The
Promiserejects with a TypeError if:- 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, the
Promiserejects with a TypeError if the worklet module has not been added with Worklet.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 withundefined.
Examples
window.sharedStorage
.set("ab-testing-group", "0", {
ignoreIfPresent: true,
})
.then(() => console.log("Set operation completed"));
Specifications
Browser compatibility
See also
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
