@delvedor/volatile

Volatile

Currently Volatile is a pet project, use at your own risk.
Obviously if you like it and you want to contribute to make it something more, contributions are well accepted!

Volatile is an in-memory, volatile key-value store database. It can memorize all the standard javascript types.
It can be useful for testing or for saving some parameters/configuration or on Heroku if you don't need a more sophisticated database.

As you can guess from the name, its peculiarity it is the fact of being volatile, all your stored data is lost if you relaunch the process. (Don't worry, if you really need it, you can use the dump function)

.get, .put and .del api are designed in the same way of LevelDB, so if you need to pass from Volatile to LevelDB or vice versa you don't need to rewrite the code!

Needs Node.js ≥ 4.0.0

Install

npm install @delvedor/volatile --save

Usage

const db = require('volatile')()

db.put('key1', 'value1', (err) => {
  if (err) console.log(err)
})

db.get('key1', (err, value) => {
  if (err) console.log(err)
  console.log(value)
})

db.all((err, iterable) => {
  if (err) return console.log(err)
  for (let [key, value] of iterable()) {
    console.log(key, value)
  }
})

db.del('key1', (err) => {
  if (err) console.log(err)
})

Options

option	default	description
overwrite	true	if setted to false, .put() returns an error if the key already exists.

How to pass options to Volatile:

const db = require('volatile')({ overwrite: false })

API

• db.get()
• db.put()
• db.del()
• db.all()
• db.size()
• db.drop()
• db.dump()

db.get(key, callback)

{ String } key is the key that you are searching.
{ Function } callback is the callback function, with two parameters, error and value.

db.put(key, value, callback)

{ String } key is the key that you are saving.
{ String } value is the value that you are saving.
{ Function } callback is the callback function, with one error parameter.

db.del(key, callback)

{ String } key is the key that you are removing.
{ Function } callback is the callback function, with one error parameter.

db.get(key, callback)

{ String } key is the key that you are searching.
{ Function } callback is the callback function, with two parameters, error and an iterator.

db.size()

Returns the total number of the keys stored in Volatile.

db.drop(callback)

{ Function } callback is the callback function, with one error parameter.
Drops the databse.

db.dump(name)

{ String } name is the name of the json file with the dump.
{ Function } callback is the callback function, with one error parameter.
Generates a json dump of the database.

TODO

• Add overwrite option
• Add .batch function

Contributing

If you feel you can help in any way, be it with examples, extra testing, or new features please open a pull request or open an issue.

The code follows the Standard code style.

License

MIT

The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

Copyright © 2016 Tomas Della Vedova