StorageArea.getKeys()
Retrieves the keys of all items in a storage area.
Syntax
let results = browser.storage.<storageType>.getKeys();
Where <storageType> is one of the storage types: sync, local, session, or managed.
Parameters
This method takes no parameters.
Return value
A Promise that resolves to an array containing storage item keys.
If the operation fails, the promise is rejected with an error message.
If managed storage is not set, undefined is returned.
Warning:
In Firefox, if an extension's managed storage has not been configured with a native manifest or using the 3rdparty enterprise policy, an exception is thrown when using this function to access managed storage (see Firefox bug 1868153). This issue can be avoided by catching the error. This issue is related to the lack of support for the storage.managed_schema manifest key (see Firefox bug 1771731).
Examples
Suppose storage contains two items:
// storage contains two items, "kitten" and "monster"
browser.storage.local.set({
kitten: { name: "Mog", eats: "mice" },
monster: { name: "Kraken", eats: "people" },
});
Retrieve keys of all items in storage.local and log the result.
browser.storage.local
.getKeys()
.then((keys) => console.log(keys)) // [ "kitten", "monster" ]
.catch((err) => console.error(`Error: ${err}`));
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
getKeys
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- See implementation notes.