https://github.com/ripeworks/local-storage-fallback

Check and use appropriate storage adapter for browser (localStorage, sessionStorage, cookies, memory)
https://github.com/ripeworks/local-storage-fallback

cookies localstorage sessionstorage

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/ripeworks/local-storage-fallback
• Owner: ripeworks
• License: mit
• Created: 2016-05-16T15:00:58.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T06:49:05.000Z (about 2 years ago)
• Last Synced: 2024-04-15T00:20:59.647Z (10 months ago)
• Topics: cookies, localstorage, sessionstorage
• Language: JavaScript
• Size: 687 KB
• Stars: 105
• Watchers: 6
• Forks: 18
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# local-storage-fallback

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

[![npm version](https://badge.fury.io/js/local-storage-fallback.svg)](https://badge.fury.io/js/local-storage-fallback)

## Installation

```

$ npm install local-storage-fallback

```

## Usage

```js

import storage from 'local-storage-fallback' // if you use es6 or typescript

// use object destructuring when using require()

// const {storage} = require('local-storage-fallback')

// Use storage directly

storage.setItem('foo', 'bar');

storage.getItem('foo'); // bar

// Or shim window.localStorage

if (!('localStorage' in window)) {

  window.localStorage = storage;

}

```

## Browser Bundle

```html

  window.localStorageFallback.setItem('foo', 'bar')

```

## Purpose

With browser settings like "Private Browsing" it has become a problem to rely on a working `window.localStorage`, 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 `localStorage` 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.