oak-lite
Oak-Lite is a lightweight version of Oak, a write-only database with a publish-subscribe model.
Getting Started
Install the oak-lite
package into your project with npm.
npm install oak-lite --save
Use the oak-lite
module in your project.
; // Configure the database (see the configuration options)let database = Oak; // Select the 'counter' racklet rack = database; // Subscribe to the racklet subscription = rack; // Publish 3 barrels to the rackrack;rack;rack; // Unsubscribe from the rack after 10 seconds;
Configuration
The following parameters can be defined when configuring an Oak-Lite database:
Parameter | Description | Required | Default |
---|---|---|---|
dataDirectory |
The directory used by this database to store racks | Yes | none |
API
The public interface for oak-lite
is defined in the API Guide.
Contributing
Pull requests are welcome! To get started, see the Contributing Guide.