Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Redis object relational mapper for NodeJs with a minimum of magic
CoffeeScript
Tree: ba07601281

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
conf
doc
lib
src
test
.gitignore
.travis.yml
LICENSE
Makefile
README.md
index.js
package.json

README.md

Build Status

Redis ORM for NodeJs

Installation

npm install ron

Usage

ron = require('ron');
// Client connection
client = ron({
  port: 6379
  host: '127.0.0.1'
  name: 'auth'
});
// Schema definition
Users = client.get('users');
Users.property('id', {identifier: true});
Users.property('username', {unique: true});
Users.property('email', {index: true, type: 'email'});
Users.property('name', {});
// Record manipulation
Users.create(
  {username: 'ron', email: 'ron@domain.com'},
  function(err, user){
    console.log(err, user.id);
  }
)

The library provide

  • Documented and tested API
  • Records access with indexes and unique values
  • Records are pure object, no state, no magic

Client API

Schema API

Records API

Run tests

Start a redis server on the default port

redis-server ./conf/redis.conf

Run the tests with mocha:

make test
Something went wrong with that request. Please try again.