haro-memcached/README.md

Memcached persistent storage adapter for Harō

# haro-memcached

[![Join the chat at https://gitter.im/avoidwork/haro-memcached](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/avoidwork/haro-memcached?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![build status](https://secure.travis-ci.org/avoidwork/haro-memcached.svg)](http://travis-ci.org/avoidwork/haro-memcached)

[Harō](http://haro.rocks) 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](https://en.wikipedia.org/wiki/Persistent_data_structure), by maintaining version sets of records in `versions` ([MVCC](https://en.wikipedia.org/wiki/Multiversion_concurrency_control)).

***haro-memcached*** is a persistent storage adapter, providing 'auto saving' behavior, as well as the ability to 
`save()`, `load()`, & `unload()` the entire DataStore or records.

### How to use
Require the adapter & register it with `haro.register(key, fn)`. The key must match the `store.adapters` key. The 
prefix will be used if set, otherwise `store.id` will be the prefix for localStorage items. Records will be have keys 
as `prefix_key`, while DataStores will be `prefix`.

For configuration options see [memcached](https://www.npmjs.com/package/memcached).

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

// Configure a store to utilize the adapter
store = haro(null, {
  adapters: {
    memcached: {
        prefix: "myData",
        locations: "String or Array",
        options: {},
        ttl: 10
    }
  }
});

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

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

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