https://github.com/mnahkies/persistent-storage

Abstracts access to any storage object implementing the webstorage Storage interface, offering optional compression using lz-string
https://github.com/mnahkies/persistent-storage

Last synced: 13 days ago
JSON representation

Abstracts access to any storage object implementing the webstorage Storage interface, offering optional compression using lz-string

• Host: GitHub
• URL: https://github.com/mnahkies/persistent-storage
• Owner: mnahkies
• License: isc
• Created: 2015-07-23T04:27:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-12T21:47:59.000Z (over 7 years ago)
• Last Synced: 2024-10-11T23:10:20.530Z (about 1 month ago)
• Language: TypeScript
• Size: 90.8 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mnahkies/persistent-storage.svg)](https://travis-ci.org/mnahkies/persistent-storage)

# persistent-storage 

Abstracts access to any storage object implementing the webstorage Storage interface, and provides some extra features:

- Seamless Serialisation / Deserialization of objects (functions and prototype etc however will not be maintained)

- Optional seamless compression using lz-string

- Optional seamless encryption using node crypto / browserify-crypto

- Optional key scoping

### Configuration

See [interfaces](https://github.com/mnahkies/persistent-storage/blob/master/lib/interfaces.ts) for documentation of configuration object

## Example Usage

    //Without Scoping

    var PersistentStore = require('persistent-store')

    

    var store = new PersistentStorage({

            useCompression: false, 

            storageBackend: new StorageShim()

        })

    store.setItem("myObj", {foo: "bar"})

    console.log(store.getItem("myObj")) // Prints {foo: "bar"}

    

    

    //With scoping

        

        var fred = new PersistentStorage({

                useCompression: true, 

                keyPrefix: 'fred'

                storageBackend: new StorageShim()

            })

            

        var bob = new  PersistentStorage({

                useCompression: false, 

                keyPrefix: 'bob'

                storageBackend: new StorageShim()

            })

    

        fred.setItem("name", "Fred")

        bob.setItem("name", "Bob")

        

        console.log(fred.getItem("name")) // prints Fred

        console.log(bob.getItem("name")) // prints  Bob

        

See unit tests [here](https://github.com/mnahkies/persistent-storage/blob/master/lib/test/PersistentStorage.test.ts) for further examples

    

## Installation

persistent-storage is available as an npm package. Simply run:

    

    npm install --save persistent-storage

    

A typescript definition file is provided with the package and will be automatically used by the typescript compiler

## Running Unit Tests

The unit tests use mocha and phantomjs, and are setup to run by the standard npm test command.

    npm install

    npm test

    

You can also run them using the browser of your choice by opening the html file [found here](https://github.com/mnahkies/persistent-storage/blob/master/lib/test/PersistentStorage.test.html)