/histore

🏬 200b key-value store backed by navigation state

Primary LanguageJavaScriptApache License 2.0Apache-2.0

histore

Histore npm

Histore [his·to·ry]: a 200b key-value store backed by navigation state.

Does the fact that sessionStorage/localStorage is shared across tabs have you down?

Don't worry, here's a strange but widely supported way to store 640kb of object data in a page's navigation state.

Usage

import histore from 'histore'

let storage = histore()

storage.set('foo', 'bar')
storage.get('foo')  // 'bar'

storage.set('obj', { any: 'object' })
storage.get('obj').any  // 'object'

Interestingly, due to the way history.replaceState works, storing objects will implicitly clone them using the Structured Clone algorithm.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Changelog

Every release, along with the migration instructions, is documented on the Github Releases page.

License

Apache 2.0