Deprecated

Please note that this project is not actively maintained anymore and that further releases to npm after 2.x.x are not for this module

Object Document Mapper (ODM) for Node.js who uses Redis as its store.

Introduction

If you need to store complex objects do Redis, but don't want to go through the trouble of translating your objects to a key, value store, then Shelf is for you. Shelf gives you CRUD operation on your objects over Redis, so you can create complex schemas and validate models.

Shelf uses joi for schema validation.

If you're using 0.10 or 0.12 node version, please use shelf@1. You can also look at the code at the 1.x.x branch.

Example

const Shelf = require('shelf')
const Joi = require('joi')

const Storage = Shelf('MyApp', {
  port: 6379,
  host: '127.0.0.1'
})

const MyModel = Storage.extend({
  name: 'MySchema',
  props: Joi.object().keys({
    prop1: Joi.string(),
    prop2: Joi.string()
  }),
  keys: ['prop1']
})

let myModel = MyModel({prop1: 'Hello'})

myModel.save()

You can (and should) move your DB connection (Shelf) and Schema (returned by the extend method) to different files to get better readability.

Check the examples for further information.

Contributing

We use standard js.

In order to run the tests you should have an Redis instance running locally.

shelf-js/shelf

Deprecated

Introduction

Example

Contributing