Giter Club home page Giter Club logo

chrome-storage-largesync's Introduction

largeSync - chrome-storage-largeSync

largeSync wraps chrome.storage.sync. it makes it easy to store objects larger than is allowed by default. Useful for Google Chrome extensions and apps.

chrome.storage.sync enforces two byte limits.

  • QUOTA_BYTES_PER_ITEM 8,192 - (measured by the JSON stringification of the item plus its key length)
  • QUOTA_BYTES 102,400 - (total across all items)

largeSync "compresses" and splits objects up between multiple keys in chrome.storage.sync, this makes QUOTA_BYTES the only relevant space limitation.

Dependencies

lz-string - "compress" strings

Install

The file to use is dist/chrome-storage-largeSync.min.js or dist/chrome-storage-largeSync.js

bower : bower install chrome-storage-largeSync --save

npm: npm install chrome-storage-largesync --save

for local build clone and run these commands npm install,bower install and grunt

Usage

largeSync exposes the same api schema as chrome.storage, The API is exposed in two different places largeSync and chrome.storage.largeSync

Methods

//get: Gets one or more items from storage.
largeSync.get(string or array of string or object keys, function callback);

//getBytesInUse: Gets the amount of space (in bytes) being used by one or more items.
largeSync.getBytesInUse(string or array of string keys, function callback);

//set : Sets multiple items.
largeSync.set(object items, function callback);

//remove: Removes one or more items from storage.
largeSync.remove(string or array of string keys, function callback);

//clear: Removes all items from storage.
largeSync.clear(function callback);

Example

var testObj = {'a' : [], 'b' : []};
for (var i = 0; i < 5000; i++) {
	testObj.a.push({text : 'sometext_a_'+i});
	testObj.b.push({text : 'sometext_b_'+i});
}
chrome.storage.largeSync.set(testObj);

chrome.storage.sync will now contain something similar to this. resulting objects in storage

to retrieve and reconstruct the object

chrome.storage.largeSync.get(["a", "b"], function(items){
	console.log(items)
	// "items" is equal to "testObj"
});

Tests

load test folder as an unpacked extension. it will override the new-tab page.


Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.