Delete User Settings

Summary

The delete method removes a stored value from User Settings by its key. Deleting a key that does not exist does not raise an error.

Purpose

  • Remove user preferences or stored data
  • Reset a setting to its default state
  • Clean up storage when user logs out or resets the extension

Syntax

SigmaSDK.WRITER.storage.user.delete(key)

Parameters

ParameterTypeRequiredDescription
keyStringYesThe key to delete from user storage
Note: Deleting a non-existent key does NOT raise an error. The Promise resolves successfully.

Basic Example

SigmaSDK.WRITER.storage.user.delete("theme")
    .then(function() {
        console.log("Theme setting removed");
    });

Delete with Confirmation

async function resetSettings() {
    if (confirm("Reset all extension settings?")) {
        await SigmaSDK.WRITER.storage.user.delete("theme");
        await SigmaSDK.WRITER.storage.user.delete("language");
        await SigmaSDK.WRITER.storage.user.delete("fontSize");
        SigmaSDK.WRITER.showBannerMessage({ type: "success", message: "Settings reset." });
    }
}

Delete Multiple Keys with Promise.all

await Promise.all([
    SigmaSDK.WRITER.storage.user.delete("theme"),
    SigmaSDK.WRITER.storage.user.delete("language"),
    SigmaSDK.WRITER.storage.user.delete("fontSize")
]);
console.log("All settings cleared");

Error Handling

SigmaSDK.WRITER.storage.user.delete("some_key")
    .then(function() {
        console.log("Key deleted (or did not exist)");
    })
    .catch(function(error) {
        console.error("Delete failed:", error);
    });

Related Pages