localforage / localforage-setitems

Adds setItems method to localForage.

localForage-setItems

Adds setItems method to localForage.

Requirements

• localForage v1.4.0+
  • for earlier versions of localforage, please use the v1.1.x releases

Installation

npm i localforage-setitems

Importing

TypeScript

Include localforage with an import statement appropriate for your configuration and import localforage-setitems right after it.

Normally, localforage-setitems will extend the prototype of locaforage to include the setItems() method, but unfortunately the typings can't be updated. As a result you should use the exported extendPrototype() method, which returns the provided localforage instance but with inherited typings that also include the setItems() method.

import localForage from 'localforage';
// OR based on your configuration:
// import * as localForage from 'localforage';

import { extendPrototype } from 'localforage-setitems';

extendPrototype(localforage);

// Keep using localForage as usual.

Known issues with module bundlers

In some ES6 module bundlers .setItems() might not automatically be made available to the localforage object on import. In this case, import the provided extendPrototype() method and extend localforage manually, as shown in the Typescript section.

jsperf links

• default driver order (indexedDB prefered)
• websql (not for firefox)

API

You can pass an array with the key-value pairs:

var items = [
  { key: 'asdf', value: 'asdf value!' },
  { key: 'asap', value: 'asap value!' },
  { key: 'async', value: 'async value!' }
];
localforage.setItems(items);

Or you can pass a object with the keys as properties:

var items = {
  asdf: 'asdf value!',
  asap: 'asap value!',
  async: 'async value!'
};
localforage.setItems(items);

localforage-setitems's Issues

UnknownError

I'm using setItems like so:

store.setItems(itemsToStore, null, null, function (err) {
if (err) {
console.log('Error!!! function: lsSetItems {.....message: ', store, itemsToStore, err);
} else {
completedSuccess(true);
}
});

i'm passing in an object whos keys are uuids, i'm doing this for multiple tables/stores with out fail however on one store I get an error...

it returns an "object IDBTransaction"

IDBTransaction.error {
name "UnknownError"
mode "readwrite"
READ_ONLY "readonly"
READ_WRITE "readwrite"
VERSION_CHANGE "versionchange"

the data it a little bit large.. maybe 5 MB among 7 keys? Before I was setting each one, one at a time so I don't think I I'm ran out of space on localstorage any ideas on how to trouble shoot this further?

IE: 11.447
LocalForage: 1.3.0
SetItems: 1.3.1

Thanks,
Jeff

Reference to '../../utils/serializer'

I'm trying to use this library in my browserify-compiled, ES6-modules-using library. Browserify chokes on:

https://github.com/localForage-extensions/localForage-setItems/blob/master/src/localforage-setitems.js#L194

with a basic not found error at build time. Is there another / better place to pull the default serializer from?

jspref tests are broken

Can't get it to work

I'm using ES6 imports on a VueJs SFC SPA.
I tried the Typescript syntax but couldn't get it to work at all. It doesn't throw errors but the setItems method isn't added. (I get the same problem with getItems btw)

Error:

[Vue warn]: Error in mounted hook: "TypeError: src_boot_lf__WEBPACK_IMPORTED_MODULE_6__.lf.setItems is not a function"

Also I think the Typescript example has a case typo in it; should be localforage not localForage when importing.

package.json is incorrect

Similar to the issue in localForage-setItems, there's a case-sensitivity mixup here:

https://github.com/localForage-extensions/localForage-setItems/blob/master/package.json#L35

bulk `removeItems`

What about implementing bulk removeItems?