deferredStorage

deferredStorage is a key-value storage that enables a performant usage of localStorage with the Background Tasks API (requestIdleCallback).

localStorage is still by far the most stable browser storage, but potential performance issues could arise when storing data with considerable size or with complex structure due to these properties:

• localStorage is a synchronous storage
• It only stores string value. When storing non-string value, serialization (i.e. JSON.strinify) is needed. Serialization could take up a considerable amount of time when data is large or has a complex structure.

deferredStorage address these issues via deferring the JSON serialization and the storing operation with the requestIdleCallback; values will not be persisted in the same call frame but only when the browser is in the idle state.

Usage

npm install deferred-storage

import deferredStorage from 'deferred-storage';

deferredStorage
    .setWhenIdle("foo", 1)
    .then(() => console.log("value is saved"))

API

setWhenIdle(key, value, options)

Set a key-value data to localStorage when browser is in the idle state.

• key: string
• value: Any seriaizable value
• options: Optional configuration object
  • timeout: If timeout is specified and the value has not been persisted by the time timeout milliseconds have passed, the persistence will be carried out during the next idle period.

Return: A Promise that resolves when the value has been successfully persisted, or when rejects when failed.

hasPending()

Return true when there are any setWhenIdle calls that have not been completed yet; return false otherwise.

const p = deferredStorage.setWhenIdle("foo", 1)

// true
console.log(deferredStorage.hasPending())

// false
p.then(() => console.log(deferredStorage.hasPending()))

commit()

Forcely complete all pending set operations synchronously in the same call frame. It is mostly called right before window is close to make sure all datas are persisted.

window.addEventListener('beforeunload', function() {
    deferredStorage.commit()
});

get(key)

Return the key's value (deserialized) from localStorage

remove(key)

Remove key from the localStorage. Synchronous operation.

clear()

Empty all keys out of the localStorage.

API Design

Only deferredStorage.setWhenIdle() call will be processed in idle time while the rest of the API will be carried out synchronously.

This design is made for the practical reason that: data serialization and localStorage.setItem() are the only potentially expensive operations. All other localStorage APIs are performant and could be called directly without performance concerns.