haro-fs

haro-fs

Harō is a modern immutable DataStore built with ES6 features, which can be wired to an API for a complete feedback loop. It is un-opinionated, and offers a plug'n'play solution to modeling, searching, & managing data on the client, or server (in RAM). It is a partially persistent data structure, by maintaining version sets of records in versions (MVCC).

haro-fs is a persistent storage adapter, providing 'auto saving' behavior, as well as the ability to save() & load() the entire DataStore.

If store.key is not set, the fail over "id" field will be id.

How to use

Require the adapter & register it with haro.register(key, fn). The key must match the store.adapters key.

If iv is specified, the file(s) on disk will contain ciphers, to be deciphered when loaded back into haro.

It is safe to reuse the same folder, the file names will be a combination of store.id + record.key.

var haro = require('haro'),
    store;

// Configure a store to utilize the adapter
store = haro(null, {
  adapters: {
    fs: {
      directory: '/path/to/files'
      iv: ''
    }
  }
});

// Register the adapter
store.register('fs', require('haro-fs'));

// Ready to `load()`, `batch()` or `set()`!

License

Copyright (c) 2015 Jason Mulligan Licensed under the BSD-3 license