Package Exports

chrome-utils

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (chrome-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

chrome-utils

Some utils that help to build chrome extension. HAVE NO DEPENDENCIES.

Usage

$ npm i chrome-utils --save

import { store, message, i18n } from 'chrome-utils';

Api

store

chrome.storage API is anti-human, for example, if you saved a non-plain object to store, {a: {b: 1, c: {d: 2}}}, then how to directly get the value of d from it?

One more question, if you have already save {a1: {b: 1}, a2: {c: 2}} to store, then wanna update b to 2, then how to do it? If we use raw API like chrome.storage.sync.set({a1: {b: 2}}), then we'll find a2 was totally disappeard!

Actually, by raw chrome.storage API:

you can only get the top key-value
you can only get a but not a.b.d.
if you wanna update a value in a object, you must get it from store first, then update to whole object, then save it to store.

WTF?

get & set

store.get(key[, resolve, reject]);
store.set(obj[, resolve]);
store.set(key, value[, resolve]);

// usage example
store.set({
  a: {
    c: 1
  }
});
// or store.set('a.c', 1);
store.get('a'); // {c: 1}

store.set('a.b': 2);
store.get('a'); // inject b, get {a: {b: 2, c: 'c'}}
store.get('a.b'); // directly get b, return 2

store.set('a.b': 3);
store.get('a.b'); // update, get 3

merge

If target value exist, then try to merge it; otherwise, create a new key-value object

store.merge(key, value[, resolve]);

store.get('a'); // null
store.merge('a.b', 1); // create new object: {a: {b: 1}}
store.merge('a', {c: 2}); // result: {a: {b: 1, c: 2}}
store.merge('a.b', 2); // update: {a: {b: 2, c: 2}}

listen

store.listen(...listeners);

// listener
const listener = {
  key, // the key you wanna to listen change
  callback
};
const listeners = [listener1, listener2, listener3];

clear & remove

store.clear();
store.remove(key[, callback]);

message

send message

message.sendMsg(msg[, callback]);

// msg
const msg = {
  type, // required
  data
};

send to tabs

message.sendToTabs(msg[, query]);

message.register(...listeners);

// listener
const listener = {
  callback, // required,
  type // not required, but if you use it, this listener will only listen same type msg
}

i18n

get message

i18n.message(...args);