aedes-persistence-redis/README.md
Matteo Collina eb1e4d0da0 Added docs for Redis options
Fixes #4.
2016-05-20 16:17:33 +02:00

1,022 B

aedes-persistence-redis  Build Status

Aedes persistence, backed by Redis.

See aedes-persistence for the full API, and Aedes for usage.

Install

npm i aedes aedes-persistence-redis --save

API

aedesPersistenceRedis([opts])

Creates a new instance of aedes-persistence-redis. It takes all the same options of ioredis, which is used internally to connect to Redis.

This constructor creates two connections to Redis.

Example:

aedesPersistenceRedis({
  port: 6379,          // Redis port
  host: '127.0.0.1',   // Redis host
  family: 4,           // 4 (IPv4) or 6 (IPv6)
  password: 'auth',
  db: 0
})

License

MIT