Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: v0.0.4
Fetching contributors…

Cannot retrieve contributors at this time

79 lines (60 sloc) 1.211 kb

Redis ORM for NodeJs

Installation

npm install ron

Usage

ron = require('ron');
client = ron({
    redis_port: 6379
    redis_host: '127.0.0.1'
    name: 'auth'
});
users = client.define('users');
users.property('id', {identifier: true});
users.property('username', {unique: true});
users.property('email', {index: true, email: true});
users.property('name', {});

The library provide

  • Simple & tested API
  • Sortable indexes and unique values
  • Records are pure object, no extended class, no magic properties

Client API

  • Client::constructor
  • Client::quit
  • Client::define

Schema API

  • Records::property
  • Records::identifier
  • Records::index
  • Records::unique
  • Records::email

Record API

  • Records::all
  • Records::count
  • Records::create
  • Records::exists
  • Records::get
  • Records::id
  • Records::list
  • Records::remove
  • Records::update

Run tests

Start a redis server (tested against version 2.9.0) on the default port

redis-server ./conf/redis.conf

Run the test suite with expresso:

expresso -s
Jump to Line
Something went wrong with that request. Please try again.