local-sync

    2.0.5 • Public • Published

    Local Sync npm

    A friendly, tiny, and cross-browser local storage solution:

    ✓ No dependencies
    ✓ Synchronous
    ✓ Namespaced storage support
    ✓ In-memory fallback

    Install

    yarn add local-sync
    
    CDN

    Common JS

    https://unpkg.com/local-sync@x.x.x/dist/cjs/local-sync.js
    https://unpkg.com/local-sync@x.x.x/dist/cjs/local-sync.min.js
    

    ES Module

    https://unpkg.com/local-sync@x.x.x/dist/esm/local-sync.js
    https://unpkg.com/local-sync@x.x.x/dist/esm/local-sync.min.js
    

    UMD

    https://unpkg.com/local-sync@x.x.x/dist/umd/local-sync.js
    https://unpkg.com/local-sync@x.x.x/dist/umd/local-sync.min.js
    

    API

    See API Documentation.

    Usage

    Buckets

    Set or get the current bucket. Subsequent methods operate only in the current bucket namespace.

    ls = new LocalSync()              // default settings
    ls = new LocalSync({              // custom settings
      prefix: 'ocean',
      bucket: 'fish',
      separator: '~'
    })
     
    ls.setBucket('BikiniBottom')      // => 'BikiniBottom'
    ls.getBucket()                    // => 'BikiniBottom'

    List all buckets in storage.

    ls.allBuckets()                   // => [...buckets]

    set, get, put

    Use any JSON serializable data type.

    ls.set('bob', {name: 'SpongeBob'})
    ls.get('bob')
    // => {name: 'SpongeBob'}
     
    ls.set('quotes', ['Squidward!'])
    ls.get('quotes')
    // => ['Squidward!]

    Update stored objects and arrays.

    ls.put('bob', {address: '124 Conch Street'})
    // => {name: 'SpongeBob', address: '124 Conch Street'}
     
    ls.put('quotes', ['Why so crabby, Patty?'])
    // => ['Squidward!', 'Why so crabby, Patty?']

    keys, values, getAll

    List all keys in storage.

    ls.keys()
    // => ['bob', 'quotes']

    List all values in storage.

    ls.values()
    // [
    //   {address: '124 Conch Street', name: 'SpongeBob'},
    //   ['Squidward!', 'Why so crabby, Patty?']
    // ]

    List all keys and values in storage.

    ls.getAll()
    // [
    //   {address: '124 Conch Street', name: 'SpongeBob'},
    //   {quotes: ['Squidward!', 'Why so crabby, Patty?']}
    // ]

    remove, clear

    Remove a single value by key or clear all values.

    ls.remove('bob')
    ls.keys()
    // => ['quotes']

    Clear all keys and values.

    ls.clear()
    ls.keys()
    // => []

    Install

    npm i local-sync

    DownloadsWeekly Downloads

    5

    Version

    2.0.5

    License

    MIT

    Unpacked Size

    121 kB

    Total Files

    13

    Last publish

    Collaborators

    • deweybot
    • levithomason