keys

Category: Storage

Namespace: web.storage.keys

Description

Returns an array of all key names currently in the app's persistent key-value store. Useful for iterating all stored values or checking what data has been saved.

Syntax

const keyList = await web.storage.keys();

Parameters

None

Returns

Promise<string[]> - Array of key name strings. Empty array [] if no keys have been set.

Example

Simple example

const keyList = await web.storage.keys();
console.log('Stored keys:', keyList);
// e.g. ["highScore", "difficulty", "soundEnabled"]

Practical example — display all stored settings

const keyList = await web.storage.keys();
for (const key of keyList) {
    const value = await web.storage.get({ key });
    console.log(`${key} = ${value}`);
}

Advanced example — export all settings as JSON

async function exportSettings() {
    const keyList = await web.storage.keys();
    const settings = {};
    for (const key of keyList) {
        settings[key] = await web.storage.get({ key });
    }
    await web.storage.writeFile({ name: 'settings-backup.json', content: JSON.stringify(settings, null, 2) });
    console.log('Settings exported.');
}

Related Methods

• web.storage.get() - Read a value by key
• web.storage.remove() - Delete a key
• web.storage.clear() - Delete all keys

Notes

• Returns key names only, not values — use get() to retrieve each value
• Order of keys is not guaranteed
• Returns an empty array (not null) when no keys exist