/locket

A pure-JavaScript implementation of LevelDB for LevelUP.

Primary LanguageJavaScriptMIT LicenseMIT

Locket

Actions Status codecov License: MIT

Salvage Necklace 5: Inside Locket by B Zedan.

Salvage Necklace 5: inside locket

A pure-JavaScript leveldown implementation backed by a persistent and durable evented I/0 b-tree for use with levelup — i.e. a database.

What Where
Discussion #1
Documentation https://bigeasy.github.io/locket
Source https://github.com/bigeasy/locket
Issues https://github.com/bigeasy/locket/issues
CI https://travis-ci.org/bigeasy/locket
Coverage: https://codecov.io/gh/bigeasy/locket
License: MIT

Locket installs from NPM.

npm install locket

Living README.md

This README.md is also a unit test using the Proof unit test framework. We'll use the Proof okay function to assert out statements in the readme. A Proof unit test generally looks like this.

require('proof')(4, okay => {
    okay('always okay')
    okay(true, 'okay if true')
    okay(1, 1, 'okay if equal')
    okay({ value: 1 }, { value: 1 }, 'okay if deep strict equal')
})

You can run this unit test yourself to see the output from the various code sections of the readme.

git clone git@github.com:bigeasy/locket.git
cd locket
npm install --no-package-lock --no-save
node test/readme.t.js

Usage

okay('okay')