kvdb.io

    1.0.5 • Public • Published

    KVdb.io JavaScript API client

    API client for KVdb.io, a managed key-value storage service that lets you quickly build applications in the key-value domain without worrying about backend infrastructure.

    Features

    • Minimal
    • Async-ready and Promises-friendly
    • Only a single dependency when used from node.js (node-fetch)
    • Uses the Fetch API, making it compatible for use with both node.js and the browser

    Example Usage

    Client-Side

    Drop this line into your HTML source:

    <script src="https://unpkg.com/kvdb.io@v1.0"></script>

    Server-Side

    Install npm module:

    npm i kvdb.io

    Use it:

    const KVdb = require('kvdb.io')

    Use the API

    const bucket = KVdb.bucket('MY_BUCKET_ID', 'MY_ACCESS_TOKEN') // access token arg optional
     
    const myapp = async () => {
      // set a key
      await bucket.set('users:1:flavor', 'oatmeal')
     
      // get a key
      let res = await bucket.get('users:1:flavor')
      console.log('flavor: ', res)
     
      // increment a key
      await bucket.incr('users:1:profile_views', 1)
     
      // list key by prefix (returns an array of keys)
      res = await bucket.list({prefix: 'users:1:'})
      console.log('keys: ', res)
     
      // list key-values by prefix (returns an array of [key, value] tuples)
      res = await bucket.list({prefix: 'users:1:', values: true})
      for (const [key, value] of res) {
        console.log(`key: ${key} => ${value}`)
      }
     
      // delete a key
      await bucket.delete('users:1:flavor')
    }
     
    myapp()

    LocalForage Driver

    If you're interested in using the KVdb localForage driver, it's easy:

    <script src="localforage.js"></script>
    <script src="https://unpkg.com/kvdb.io@v1.0"></script>
    <script>
    KVdb.installLocalForageDriver(localforage)
     
    localforage.config({
      bucket: KVdb.bucket('MY_BUCKET_ID', 'MY_ACCESS_TOKEN')
    })
     
    localforage.setDriver([KVdb.LOCALFORAGE_DRIVER])
      .then(() => localForage.setItem('foo', 'bar'))
      .then(() => localForage.getItem('foo'))
      .then(value => alert('value: ' + value))
    </script> 

    License

    MIT

    Install

    npm i kvdb.io

    Homepage

    kvdb.io

    DownloadsWeekly Downloads

    18

    Version

    1.0.5

    License

    MIT

    Unpacked Size

    16.4 kB

    Total Files

    5

    Last publish

    Collaborators

    • amir