chrome.storage

refresh date: 2026-09-25 robots: noindex

ब्यौरा

उपयोगकर्ता के डेटा को सेव करने, वापस पाने, और उसमें हुए बदलावों को ट्रैक करने के लिए, chrome.storage API का इस्तेमाल करें.

अनुमतियां

storage

खास जानकारी

Storage API, उपयोगकर्ता के डेटा और स्थिति को बनाए रखने के लिए, एक्सटेंशन के हिसाब से तरीका उपलब्ध कराता है. यह वेब प्लैटफ़ॉर्म के स्टोरेज एपीआई (IndexedDB और स्टोरेज) की तरह ही है. हालांकि, इसे एक्सटेंशन के स्टोरेज की ज़रूरतों को पूरा करने के लिए डिज़ाइन किया गया है. यहां कुछ मुख्य सुविधाओं के बारे में बताया गया है:

  • एक्सटेंशन के सभी कॉन्टेक्स्ट के पास Storage API का ऐक्सेस होता है. इनमें एक्सटेंशन सर्विस वर्कर और कॉन्टेंट स्क्रिप्ट शामिल हैं.
  • JSON सीरियलाइज़ की जा सकने वाली वैल्यू, ऑब्जेक्ट प्रॉपर्टी के तौर पर सेव की जाती हैं.
  • Storage API, एसिंक्रोनस है. इसमें डेटा को एक साथ पढ़ने और सेव करने की कार्रवाइयां की जा सकती हैं.
  • अगर उपयोगकर्ता कैश मेमोरी और ब्राउज़िंग इतिहास को मिटा देता है, तब भी डेटा सेव रहता है.
  • स्प्लिट गुप्त मोड का इस्तेमाल करने पर भी, सेव की गई सेटिंग बनी रहती हैं.
  • इसमें एंटरप्राइज़ की नीतियों के लिए, रीड-ओनली मोड वाला मैनेज किया गया स्टोरेज एरिया शामिल है.

हालांकि, एक्सटेंशन कुछ मामलों (पॉप-अप और अन्य एचटीएमएल पेजों) में [Storage][mdn-storage] इंटरफ़ेस (window.localStorage से ऐक्सेस किया जा सकता है) का इस्तेमाल कर सकते हैं, लेकिन इन वजहों से इसका सुझाव नहीं दिया जाता है:

  • एक्सटेंशन का सर्विस वर्कर, Storage को ऐक्सेस नहीं कर सकता.
  • कॉन्टेंट स्क्रिप्ट, होस्ट पेज के साथ स्टोरेज शेयर करती हैं.
  • जब उपयोगकर्ता अपना ब्राउज़िंग इतिहास मिटाता है, तो Storage इंटरफ़ेस का इस्तेमाल करके सेव किया गया डेटा मिट जाता है.

सर्विस वर्कर से, वेब स्टोरेज एपीआई से एक्सटेंशन स्टोरेज एपीआई में डेटा ट्रांसफ़र करने के लिए:

  1. कन्वर्ज़न रूटीन और [onMessage][on-message] हैंडलर की मदद से, ऑफ़स्क्रीन दस्तावेज़ बनाएं.
  2. ऑफ़स्क्रीन दस्तावेज़ में कन्वर्ज़न रूटीन जोड़ें.
  3. एक्सटेंशन सर्विस वर्कर में, अपने डेटा के लिए chrome.storage देखें.
  4. अगर आपका डेटा नहीं मिलता है, तो ऑफ़स्क्रीन दस्तावेज़ [बनाएं][create-offscreen] और कन्वर्ज़न रूटीन शुरू करने के लिए, [sendMessage()][send-message] को कॉल करें.
  5. ऑफ़स्क्रीन दस्तावेज़ के onMessage हैंडलर में, कन्वर्ज़न रूटीन को कॉल करें.

एक्सटेंशन में वेब स्टोरेज एपीआई के काम करने के तरीके में भी कुछ अंतर होते हैं. ज़्यादा जानकारी के लिए, [स्टोरेज और कुकी][storage-and-cookies] लेख पढ़ें.

स्टोरेज एरिया

Storage API को इन चार बकेट ("स्टोरेज एरिया") में बांटा गया है:

storage.local
डेटा को डिवाइस पर सेव किया जाता है. एक्सटेंशन हटाने पर, यह डेटा मिट जाता है. कोटा की सीमा करीब 10 एमबी है. हालांकि, "unlimitedStorage" की अनुमति का अनुरोध करके इसे बढ़ाया जा सकता है. ज़्यादा डेटा सेव करने के लिए, इसका इस्तेमाल करें.
storage.sync
अगर सिंक करने की सुविधा चालू है, तो डेटा को उस Chrome ब्राउज़र के साथ सिंक किया जाता है जिसमें उपयोगकर्ता ने लॉग इन किया है. अगर इसे बंद किया जाता है, तो यह storage.local की तरह काम करता है. ऑफ़लाइन होने पर, Chrome डेटा को डिवाइस में सेव करता है. ऑनलाइन होने पर, वह डेटा को सिंक करना फिर से शुरू कर देता है. कोटा की सीमा करीब 100 केबी है. इसमें हर आइटम के लिए 8 केबी की सीमा है. सिंक किए गए ब्राउज़र पर उपयोगकर्ता की सेटिंग को सुरक्षित रखने के लिए, इसका इस्तेमाल करें.
storage.session
यह ब्राउज़र सेशन के दौरान, डेटा को मेमोरी में सेव रखता है. डिफ़ॉल्ट रूप से, इसे कॉन्टेंट स्क्रिप्ट के लिए उपलब्ध नहीं कराया जाता. हालांकि, chrome.storage.session.setAccessLevel() को सेट करके, इसे बदला जा सकता है. कोटा की सीमा करीब 10 एमबी है. इसका इस्तेमाल, सर्विस वर्कर के रन के दौरान ग्लोबल वैरिएबल को सेव करने के लिए करें.
storage.managed
एडमिन, मैनेज किए जा रहे एनवायरमेंट में, काम करने वाले एक्सटेंशन की सेटिंग कॉन्फ़िगर करने के लिए, स्कीमा और एंटरप्राइज़ की नीतियों का इस्तेमाल कर सकते हैं. इस स्टोरेज एरिया को सिर्फ़ पढ़ा जा सकता है.

मेनिफ़ेस्ट

स्टोरेज एपीआई का इस्तेमाल करने के लिए, एक्सटेंशन के मेनिफ़ेस्ट में "storage" अनुमति का एलान करें. उदाहरण के लिए:

{
  "name": "My extension",
  ...
  "permissions": [
    "storage"
  ],
  ...
}

इस्तेमाल

यहां दिए गए सैंपल, local, sync, और session स्टोरेज एरिया दिखाते हैं:

storage.local

chrome.storage.local.set({ key: value }).then(() => {
  console.log("Value is set");
});

chrome.storage.local.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

storage.sync

chrome.storage.sync.set({ key: value }).then(() => {
  console.log("Value is set");
});

chrome.storage.sync.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

storage.session

chrome.storage.session.set({ key: value }).then(() => {
  console.log("Value was set");
});

chrome.storage.session.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

managed स्टोरेज एरिया के बारे में ज़्यादा जानने के लिए, स्टोरेज एरिया के लिए मेनिफ़ेस्ट देखें.

स्टोरेज और थ्रॉटलिंग की सीमाएं

Storage API में डेटा जोड़ने का मतलब यह नहीं है कि किसी बड़े ट्रक में सामान भरा जा रहा है. स्टोरेज में कुछ जोड़ने को, पाइप में कुछ डालने जैसा समझें. ऐसा हो सकता है कि पाइप में पहले से ही कुछ कॉन्टेंट मौजूद हो या वह भरा हुआ हो. हमेशा यह मानकर चलें कि स्टोरेज में डेटा जोड़ने और उसे असल में रिकॉर्ड किए जाने के बीच कुछ समय लगता है.

स्टोरेज की सीमाओं और उनके पार होने पर क्या होता है, इस बारे में जानकारी के लिए, sync, local, और session के लिए कोटा की जानकारी देखें.

उपयोग के उदाहरण

यहां दिए गए सेक्शन में, Storage API के इस्तेमाल के सामान्य उदाहरण दिए गए हैं.

स्टोरेज से जुड़े अपडेट के लिए सिंक्रोनस रिस्पॉन्स

स्टोरेज में किए गए बदलावों को ट्रैक करने के लिए, इसके onChanged इवेंट में एक लिसनर जोड़ा जा सकता है. स्टोरेज में कुछ भी बदलने पर, वह इवेंट ट्रिगर होता है. सैंपल कोड इन बदलावों को सुनता है:

background.js:

chrome.storage.onChanged.addListener((changes, namespace) => {
  for (let [key, { oldValue, newValue }] of Object.entries(changes)) {
    console.log(
      `Storage key "${key}" in namespace "${namespace}" changed.`,
      `Old value was "${oldValue}", new value is "${newValue}".`
    );
  }
});

इस आइडिया को और बेहतर बनाया जा सकता है. इस उदाहरण में, हमारे पास एक विकल्प पेज है. इसकी मदद से, उपयोगकर्ता "डीबग मोड" को टॉगल कर सकता है. हालांकि, इसे लागू करने का तरीका यहां नहीं दिखाया गया है. विकल्प पेज, नई सेटिंग को तुरंत storage.sync में सेव करता है. साथ ही, सर्विस वर्कर storage.onChanged का इस्तेमाल करके, सेटिंग को जल्द से जल्द लागू करता है.

options.html:

<!-- type="module" allows you to use top level await -->
<script defer src="options.js" type="module"></script>
<form id="optionsForm">
  <label for="debug">
    <input type="checkbox" name="debug" id="debug">
    Enable debug mode
  </label>
</form>

options.js:

// In-page cache of the user's options
const options = {};
const optionsForm = document.getElementById("optionsForm");

// Immediately persist options changes
optionsForm.debug.addEventListener("change", (event) => {
  options.debug = event.target.checked;
  chrome.storage.sync.set({ options });
});

// Initialize the form with the user's option settings
const data = await chrome.storage.sync.get("options");
Object.assign(options, data.options);
optionsForm.debug.checked = Boolean(options.debug);

background.js:

function setDebugMode() { /* ... */ }

// Watch for changes to the user's options & apply them
chrome.storage.onChanged.addListener((changes, area) => {
  if (area === 'sync' && changes.options?.newValue) {
    const debugMode = Boolean(changes.options.newValue.debug);
    console.log('enable debug mode?', debugMode);
    setDebugMode(debugMode);
  }
});

स्टोरेज से एसिंक्रोनस प्रीलोड

सर्विस वर्कर हमेशा नहीं चलते हैं. इसलिए, Manifest V3 एक्सटेंशन को कभी-कभी अपने इवेंट हैंडलर को चलाने से पहले, स्टोरेज से डेटा को एसिंक्रोनस तरीके से लोड करना पड़ता है. ऐसा करने के लिए, यहां दिए गए स्निपेट में एसिंक्रोनस action.onClicked इवेंट हैंडलर का इस्तेमाल किया जाता है. यह हैंडलर, अपने लॉजिक को लागू करने से पहले, storageCache ग्लोबल के पॉप्युलेट होने का इंतज़ार करता है.

background.js:

// Where we will expose all the data we retrieve from storage.sync.
const storageCache = { count: 0 };
// Asynchronously retrieve data from storage.sync, then cache it.
const initStorageCache = chrome.storage.sync.get().then((items) => {
  // Copy the data retrieved from storage into storageCache.
  Object.assign(storageCache, items);
});

chrome.action.onClicked.addListener(async (tab) => {
  try {
    await initStorageCache;
  } catch (e) {
    // Handle error that occurred during storage initialization.
  }

  // Normal action handler logic.
  storageCache.count++;
  storageCache.lastTabId = tab.id;
  chrome.storage.sync.set(storageCache);
});

एक्सटेंशन के उदाहरण

Storage API के अन्य डेमो देखने के लिए, इनमें से कोई भी उदाहरण देखें:

टाइप

AccessLevel

Chrome 102 या इसके बाद का वर्शन

स्टोरेज एरिया का ऐक्सेस लेवल.

Enum

"TRUSTED_CONTEXTS"
इससे एक्सटेंशन से मिलने वाले कॉन्टेक्स्ट के बारे में पता चलता है.

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
इससे एक्सटेंशन के बाहर से आने वाले कॉन्टेक्स्ट के बारे में पता चलता है.

StorageChange

प्रॉपर्टी

  • newValue

    ज़रूरी नहीं

    अगर आइटम की कोई नई वैल्यू है, तो वह वैल्यू.

  • oldValue

    ज़रूरी नहीं

    अगर आइटम की कोई पुरानी वैल्यू थी, तो वह वैल्यू.

प्रॉपर्टी

local

local स्टोरेज एरिया में मौजूद आइटम, हर मशीन के लिए लोकल होते हैं.

टाइप

StorageArea और ऑब्जेक्ट

प्रॉपर्टी

  • QUOTA_BYTES

    10485760

    लोकल स्टोरेज में ज़्यादा से ज़्यादा कितना डेटा (बाइट में) सेव किया जा सकता है. इसे हर वैल्यू के JSON स्ट्रिंगिफ़िकेशन और हर कुंजी की लंबाई के हिसाब से मेज़र किया जाता है. अगर एक्सटेंशन के पास unlimitedStorage की अनुमति है, तो इस वैल्यू को अनदेखा कर दिया जाएगा. इस सीमा को पार करने वाले अपडेट तुरंत फ़ेल हो जाते हैं. साथ ही, कॉलबैक का इस्तेमाल करने पर runtime.lastError सेट हो जाता है. इसके अलावा, async/await का इस्तेमाल करने पर, Promise को अस्वीकार कर दिया जाता है.

managed

managed स्टोरेज एरिया में मौजूद आइटम, डोमेन एडमिन की कॉन्फ़िगर की गई एंटरप्राइज़ नीति के हिसाब से सेट किए जाते हैं. साथ ही, एक्सटेंशन के लिए ये आइटम रीड-ओनली होते हैं. इस नेमस्पेस में बदलाव करने की कोशिश करने पर गड़बड़ी होती है. किसी नीति को कॉन्फ़िगर करने के बारे में जानने के लिए, स्टोरेज एरिया के लिए मेनिफ़ेस्ट देखें.

टाइप

StorageArea

sync

sync स्टोरेज एरिया में मौजूद आइटम, Chrome सिंक का इस्तेमाल करके सिंक किए जाते हैं.

टाइप

StorageArea और ऑब्जेक्ट

प्रॉपर्टी

  • MAX_ITEMS

    512

    सिंक किए गए स्टोरेज में ज़्यादा से ज़्यादा कितने आइटम सेव किए जा सकते हैं. इस सीमा को पार करने वाले अपडेट तुरंत फ़ेल हो जाएंगे. साथ ही, कॉलबैक का इस्तेमाल करने पर या प्रॉमिस अस्वीकार होने पर, runtime.lastError सेट हो जाएगा.

  • MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

    1000000

    अब काम नहीं करता

    storage.sync API में अब डेटा सेव करने के लिए, लगातार राइट ऑपरेशन करने का कोटा नहीं है.

  • MAX_WRITE_OPERATIONS_PER_HOUR

    1800

    हर घंटे set, remove या clear से जुड़ी ज़्यादा से ज़्यादा कार्रवाइयां की जा सकती हैं. इसका मतलब है कि हर दो सेकंड में एक बार डेटा लिखा जा सकता है. यह सीमा, कम समय के लिए हर मिनट डेटा लिखने की सीमा से कम है.

    इस सीमा को पार करने वाले अपडेट तुरंत फ़ेल हो जाते हैं. साथ ही, कॉलबैक का इस्तेमाल करने पर या प्रॉमिस अस्वीकार होने पर, runtime.lastError सेट हो जाता है.

  • MAX_WRITE_OPERATIONS_PER_MINUTE

    120

    हर मिनट में set, remove या clear से जुड़ी ज़्यादा से ज़्यादा कितनी कार्रवाइयां की जा सकती हैं. यह हर सेकंड दो बार होता है. इससे कम समय में, हर घंटे होने वाले राइट ऑपरेशन की तुलना में ज़्यादा थ्रूपुट मिलता है.

    इस सीमा को पार करने वाले अपडेट तुरंत फ़ेल हो जाते हैं. साथ ही, कॉलबैक का इस्तेमाल करने पर या प्रॉमिस अस्वीकार होने पर, runtime.lastError सेट हो जाता है.

  • QUOTA_BYTES

    102400

    सिंक स्टोरेज में ज़्यादा से ज़्यादा कितना डेटा (बाइट में) सेव किया जा सकता है. इसे हर वैल्यू के JSON स्ट्रिंगिफ़िकेशन और हर कुंजी की लंबाई के हिसाब से मेज़र किया जाता है. इस सीमा को पार करने वाले अपडेट तुरंत फ़ेल हो जाते हैं. साथ ही, कॉलबैक का इस्तेमाल करने पर या प्रॉमिस अस्वीकार होने पर, runtime.lastError सेट हो जाता है.

  • QUOTA_BYTES_PER_ITEM

    8192

    सिंक स्टोरेज में मौजूद हर आइटम का ज़्यादा से ज़्यादा साइज़ (बाइट में). इसे आइटम की वैल्यू की JSON स्ट्रिंग और उसकी कुंजी की लंबाई के हिसाब से मेज़र किया जाता है. इस सीमा से ज़्यादा आइटम वाले अपडेट तुरंत फ़ेल हो जाएंगे. साथ ही, कॉलबैक का इस्तेमाल करने पर या प्रॉमिस अस्वीकार होने पर, runtime.lastError सेट हो जाएगा.

इवेंट

onChanged

chrome.storage.onChanged.addListener(
  callback: function,
)

एक या उससे ज़्यादा आइटम बदलने पर ट्रिगर होता है.

पैरामीटर

  • कॉलबैक

    फ़ंक्शन

    callback पैरामीटर कुछ ऐसा दिखता है: 

    (changes: object, areaName: string) => void

    • बदलाव

      ऑब्जेक्ट

    • areaName

      स्ट्रिंग