chrome-storage-api

chrome-storage-api

Overview

Helper for chrome.storage API.

Notes

To use the chrome.storage API, declare the "storage" permission in the manifest:

{
  "name": "My extension",

  "permissions": ["storage"]
}

Installation

You can install this library using npm:

npm install chrome-storage-api

Usage

import { Storage } from "chrome-storage-api"

// Local Storage
Storage.Local.{get | set | push | unshift}

// Sync Storage
Storage.Sync.{get | set | push | unshift}

// Managed Storage
Storage.Managed.{get}

// Session Storage
Storage.Session.{get | set | push | unshift}

Methods

get

Gets one or more items from storage.

import { Storage } from "chrome-storage-api";

// Get a single item from storage.
const singleResult = await Storage.Local.get("key1");
console.log(singleResult);
// Output: value1

// Get multiple items from storage.
const multipleResult = await Storage.Local.get(["key1", "key2"]);
console.log(multipleResult);
// Output: [value1, value2]

// Get items with default values.
const resultWithDefaultValue = await Storage.Local.get({
  key4: "value4",
  key5: "value5",
});
console.log(resultWithDefaultValue);
// Output: { key4: "value4", key5: "value5" }

// Get items using a callback function.
Storage.Local.get("key1", (items) => console.log(items));
// Output: { key1: "value1" }

set

Sets multiple items.

import { Storage } from "chrome-storage-api";

Storage.Local.set({ key3: "value3" }, () => console.log("Value 3 was set."));

onChange

Fired when one or more items change.

import { Storage } from "chrome-storage-api";

Storage.onChange((changes, areaName) => {
  console.log(`New Value: ${changes.key1.newValue}`);
  console.log(`Old Value: ${changes.key1.oldValue}`);
  console.log(`Area Name: ${areaName}`);
});

// Outputs:
//   New Value: new value1
//   Old Value: value1
//   Area Name: local

push

Pushes values to a specified key in the Chrome storage.

import { Storage } from "chrome-storage-api";

await Storage.Local.set({ key4: ["value1", "value2"] });
await Storage.Local.push("key4", ["value3", "value4"]);

Storage.Local.get("key4", (items) => console.log(items));
// Output: Array(4)[value1, value2, value3, value4]

unshift

Unshifts values to a specified key in the Chrome storage.

import { Storage } from "chrome-storage-api";

await Storage.Local.set({ key5: ["value3", "value4"] });
await Storage.Local.unshift("key5", ["value1", "value2"]);

Storage.Local.get("key5", (items) => console.log(items));
// Output: Array(4)[value1, value2, value3, value4]

Link

• chrome.storage

License

This project is licensed under the MIT License - see the LICENSE file for details.