redis.token
Version:
token based storage system in Redis that uses hashtables.
90 lines (67 loc) • 1.99 kB
Markdown
[](https://travis-ci.org/ChrisCates/redis.token)
[](https://coveralls.io/github/ChrisCates/redis.token?branch=master)
[](https://nodei.co/npm/redis.token/)
# redis.token
## A token based storage system in Redis that uses hashtables.
### Installation
```bash
npm install redis.token --save
```
### Usage
This NPM module automatically converts key value objects into hash tables.
The `Redis.GET` command automatically returns an object in the `redis` npm module.
Two dependencies for this project is (NPM):
```bash
crypto-js
redis
```
### Demo
```javascript
var config = {
host: "localhost",
port: 6379,
path: null,
url: null,
//etc (refer to redis npm docs for full configuration)
}
var redis = require("redis.token")(config, function(err) {
if (err) throw err
})
redis.generate(
{
"key": "value",
"key2": "value"
},
function(err, key) {
if (err) throw err
//Returns randomly generated SHA3 token
console.log(key)
redis.get(key.token, function(err, reply) {
if (err) throw err
/*
Returns
{
"key": "value",
"key2": "value"
}
*/
console.log(reply)
})
}
)
```
### API
#### redis.token.generate(obj,callback)
Generates a hashtable with the key values in `obj`, callback returns a token.
#### redis.token.get(token,callback)
With the token generated in `.generate()` you can retrieve the object stored.
### You can curry your own salt with a function
```javascript
var config = {
salt: crypto.randomBytes(100)
}
```
This is an optional configuration for the NPM module!
#### Licensed under © MIT