kvs

Simple key-value store facade for node.

Installation

$ npm install kvs

Methods

set(key, val)
get(key)
del(key)
getset(key, value)
getdel(key)
keys()
clear()

Usage

Classic usage

const {Store} = require('kvs');

const TTL = 100;
const store = Store.create('memory');

(async () => {
  const bucket1 = store.bucket({ttl: TTL /*seconds*/});
  // const memoryBucket = await memoryStore.createBucket({max: 100, ttl: 10/*seconds*/});

  await bucket1.set('foo', 'bar');
  let result = await bucket1.get('foo');
  console.log(result);
  await bucket1.del('foo');

  const userId = 123;
  const key = '#' + userId; // for test if key is not the parameter (user_id) to load.

  // Using namespace "user"
  const bucket2 = store.bucket('user', {
    ttl: TTL /*seconds*/,

    // method to load a thing if it's not in the bucket.
    load: loadUser,
  });

  // `user_id` is the parameter used to load.
  // if no parameter is specified for loading, the `key` will be used.
  let user = await bucket2.get(key, userId);
  console.log(user);

  // Second time fetches user from  bucket2
  user = await bucket2.get(key, userId);
  console.log(user);

  // Outputs:
  // Returning user from slow database.
  // { id: 123, name: 'Bob' }
  // { id: 123, name: 'Bob' }

  await store.close();
})();

async function loadUser(id) {
  await new Promise(resolve => setTimeout(resolve, 100));
  console.log('Returning user from slow database.');
  return {id: id, name: 'Bob'};
}

// Outputs:
// bar
// Returning user from slow database.
// { id: 123, name: 'Bob' }
// { id: 123, name: 'Bob' }

With typings

import {Store} from 'kvs';

interface Settings {
  name: string;
  ttl: number;
}

async () => {
  const store = new Store('memory');
  const bucket = store.bucket<Settings>('settings');
  await bucket.set('name', 'foo');
  await bucket.set('ttl', '3600');

  console.log(await bucket.get('name'));
  // => foo
  console.log(await bucket.get('ttl'));
  // => 3600
};

Tests

$ npm test

License

kvs is licensed under the MIT license.