User Settings

Summary

User Settings provide persistent per-user storage for extension data. Settings are scoped to the user and persist across all documents. Use this for preferences, configuration, and user-specific data.

Overview

  • Store per-user preferences (theme, language, defaults)
  • Data persists across documents and browser sessions
  • Key-value storage model (values must be strings)
  • All operations return Promises

Sub-Sections

API Reference

// Fetch a value
SigmaSDK.WRITER.storage.user.fetch("key")
    .then(value => console.log(value));

// Add / Update a value
SigmaSDK.WRITER.storage.user.add({ key: "key", value: "value" })
    .then(() => console.log("Saved"));

// Delete a value
SigmaSDK.WRITER.storage.user.delete("key")
    .then(() => console.log("Deleted"));

Scope Comparison

FeatureUser SettingsDocument Settings
ScopePer userPer document
Persists across documents?YesNo
Use CaseUser preferences, API keysDocument notes, config

Related Pages