Nutritious Pancake Mountain

    humble-localstorage

    2.0.0 • Public • Published

    humble-localstorage

    wraps localStorage and adds .getObject(), .setObject(), .isPersistent

    Build Status Dependencies Status devDependency Status Greenkeeper badge

    localStorage is a simple key/value store API for browsers, perfectly suited to store little amount of data like configurations.

    humbleLocalStorage provides additional APIs to store / retrieve JSON objects, and also handles several circumstances in which Browsers do not support or persist localStorage (e.g. private modes, Cookies disabled, etc).

    In case data cannot be persisted in localStorage, humbleLocalStorage falls back to in-memory storage. To determine if data is being persisted, use humbleLocalStorage.isPersistent property.

    Installation

    Usage

    humbleLocalStorage.getItem('mykey') // string value or null
    humbleLocalStorage.setItem('mykey', 123) // stored as '123'
    humbleLocalStorage.removeItem('mykey')
    humbleLocalStorage.clear() // removes all data
    humbleLocalStorage.key(0) // name of key by numeric index, or null
    humbleLocalStorage.length // number of stored keys
     
    humbleLocalStorage.getObject('mykey') // JSON value or null
    humbleLocalStorage.setObject('mykey', {foo: 'bar'}) // stored as '{"foo": "bar"}'
    humbleLocalStorage.isPersistent // true if data persists page reload, false if not

    Run tests

    # see all available tasks
    npm run
    
    # run unit & integration tests
    # note: selenium must be running
    npm test
    

    License

    MIT

    Install

    npm i humble-localstorage

    DownloadsWeekly Downloads

    5,290

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    50.1 kB

    Total Files

    12

    Last publish

    Collaborators

    • gr2m