Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

datakey

Miramac5ISC1.0.0

Provides auto generating keys from objects

key, level db

readme

datakey

Provides auto generating keys from objects. Uses '\x00' (null) as default divider.

.get(data, keys)

    var Datakey = require('datakey');

    var datakey1 = new Datakey(),
    keys = ['ID', 'name'],
    testData = { ID: 1, name: 'AA', result: 1000 },
    key;

    datakey1.get(testData, keys); // retruns: '1\x00AA'

    var datakey2 = new Datakey({divider: '!'});
    datakey2.get(testData, keys); // retruns: '1!AA'

.levelup(data, keys)

converts data into a levelup batch transaction object

    var Datakey = require('datakey');

    var datakey = new Datakey(),
    keys = ['ID', 'name'],
    testData = [{ ID: 1, name: 'AA', result: 56 },{ ID: 1, name: 'AB', result: 67 }],
    key;

    datakey.levelup(testData, keys)[0].key; // retruns: '1\x00AA'

    datakey.levelup(testData, keys)[1].value.name; // retruns: 'AB'

    //level up batch transaction (https://github.com/rvagg/node-levelup#batch)
    leveldb.batch(datakey.levelup(testData, keys));