Revision 1132105 of storage.local

<div>{{AddonSidebar()}}</div>

<p>Represents the <code>local</code> storage area. Items in <code>local</code> storage are local to the machine the add-on was installed on.</p>

<p>When the add-on is uninstalled, its associated local storage is cleared (note that in Firefox, this is only true from version 51 onwards).</p>

<p>Also in Firefox, you can prevent the browser from clearing local storage on uninstall by visiting "about:config" and setting the following two browser preferences to <code>true</code>: "keepUuidOnUninstall" and "keepStorageOnUninstall". This feature is provided to help developers test their add-on. WebExtensions themselves are not able to change these preferences.</p>

<h2 id="Methods">Methods</h2>

<p>The <code>local</code> object implements the methods defined on the {{WebExtAPIRef("storage.StorageArea")}} type:</p>

<dl>
 <dt>{{WebExtAPIRef("storage.StorageArea.get()")}}</dt>
 <dd>Retrieves one or more items from the storage area.</dd>
 <dt>{{WebExtAPIRef("storage.StorageArea.getBytesInUse()")}}</dt>
 <dd>Gets the amount of storage space (in bytes) used one or more items being stored in the storage area.</dd>
 <dt>{{WebExtAPIRef("storage.StorageArea.set()")}}</dt>
 <dd>Stores one or more items in the storage area. If the item already exists, its value will be updated. When you set a value, the {{WebExtAPIRef("storage.onChanged")}} event will fire.</dd>
 <dt>{{WebExtAPIRef("storage.StorageArea.remove()")}}</dt>
 <dd>Removes one or more items from the storage area.</dd>
 <dt>{{WebExtAPIRef("storage.StorageArea.clear()")}}</dt>
 <dd>Removes all items from the storage area.</dd>
</dl>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p>

<p>{{ CompatibilityTable() }}</p>

<p>{{WebExtBrowserCompat}}</p>

<p>{{WebExtExamples}}</p>

<div class="note"><strong>Acknowledgements</strong>

<p>This API is based on Chromium's <a href="https://developer.chrome.com/extensions/storage#property-local"><code>chrome.storage</code></a> API. This documentation is derived from <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/storage.json"><code>storage.json</code></a> in the Chromium code.</p>

<p>Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.</p>
</div>

<div class="hidden">
<pre>
// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>