Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.64 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.64 KB
Raw

Session Storage Fallback

semantic-release

Check and use appropriate storage adapter for browser (sessionStorage, cookies, memory)

This repository was cloned from github.com/ripeworks/local-storage-fallback due to a need to fallback from session storage rather than local storage.

Installation

$ npm install session-storage-fallback

Usage

import storage from 'session-storage-fallback' // if you use es6 or typescript
// use object destructuring when using require()
// const {storage} = require('session-storage-fallback')

// Use storage directly
storage.setItem('foo', 'bar');
storage.getItem('foo'); // bar

// Or shim window.sessionStorage
if (!('sessionStorage' in window)) {
  window.sessionStorage = storage;
}

Purpose

With browser settings like "Private Browsing" it has become a problem to rely on a working window.sessionStorage, even in newer browsers. Even though it may exist, it will throw exceptions when trying to use setItem or getItem. This module will run appropriate checks to see what browser storage mechanism might be available, and then expose it. It uses the same API as sessionStorage so it should work as a drop-in replacement in most cases.

Gotchas

  • CookieStorage has storage limits. Be careful here.
  • MemoryStorage will not persist between page loads. This is more or less a stop-gap to prevent page crashes, but may be sufficient for websites that don't do full page loads.