CupDB

A text based key-value database for Node and Electron.

Usage

npm install cupdb

const cup = require('cupdb')
const db = cup('data.db')

// set
await db.setItem('a', 123)
await db.setItem('b', 'BBB')
await db.setItem('c', ['a', 'b', 'c'])
await db.setItem('d', {x: 100, y: 200})

// get
await db.getItem('a') // 123
await db.getItem('b') // BBB
(await db.getItem('c')).join(',') // a,b,c
(await db.getItem('d')).x // 100

// close
await db.close()

API

cup(file_path)

Return an instance of CupDB, the data will be saved to file_path.

db.setItem(key, value)

Set item with key and value.

db.getItem(key)

Get item with key, undefined will be returned if not found.

db.getItems(keys)

Get items with keys, the returned value is an array.

db.getItems(['k1', 'k2', 'k3']) // resule: [v1, v2, v3]

db.getAll()

Get all items, the returned value is an array.

db.getKeys()

Get all keys of items.

db.remove(key)

Remove the item with key.

db.remove('abc')

// or remove severail items in one command
db.remove(['abc', 'd2', 'd3', 'd4'])

db.find(filter)

Find items by filter, the filter is a function, the returned value is an array.

db.find((key, value) => {
  return /^my_/.test(key) && typeof value === 'string'
})

db.dump()

Organize and persist data to the hard disk.

db.close()

Close current db, the db.dump() method will be called by db.close().

License

MIT.