4.2.4 • Published 7 years ago

catbox-redis v4.2.4

Weekly downloads
5,604
License
BSD-3-Clause
Repository
github
Last release
7 years ago

catbox-redis

Redis adapter for catbox

Build Status catbox-redis

Lead Maintainer: Marcus Poehls

Options

  • url - the Redis server URL (if url is provided, host, port, and socket are ignored)
  • host - the Redis server hostname. Defaults to '127.0.0.1'.
  • port - the Redis server port or unix domain socket path. Defaults to 6379.
  • socket - the unix socket string to connect to (if socket is provided, host and port are ignored)
  • password - the Redis authentication password when required.
  • database - the Redis database.
  • partition - this will store items under keys that start with this value. (Default: '')
  • sentinels - an array of redis sentinel addresses to connect to.
  • sentinelName - the name of the sentinel master. (Only needed when sentinels is specified)

Use a Custom Redis Client

catbox-redis allows you to specify a custom Redis client. Using a custom client puts you in charge of lifecycle handling (client start/stop).

Requirements

  • client must be compatible with the ioredis API
  • client must also expose the status property that needs to match ready when connected
  • client is ready when client.status === 'ready' resolves to true

All other options of catbox-redis are ignored when providing a custom client.

  • client - a custom Redis client instance

Tests

The test suite expects:

  • a redis server to be running on port 6379
  • a redis server listenning to port 6378 and requiring a password: 'secret'
  • a redis server listenning on socket /tmp/redis.sock

See .travis.yml

redis-server &
npm test
4.2.4

7 years ago

4.2.3

7 years ago

4.2.2

7 years ago

4.2.1

7 years ago

4.2.0

7 years ago

4.1.0

7 years ago

4.0.0

8 years ago

3.1.1

8 years ago

3.1.0

8 years ago

3.0.2

8 years ago

3.0.1

8 years ago

3.0.0

8 years ago

2.0.2

9 years ago

2.0.1

9 years ago

1.0.10

9 years ago

2.0.0

9 years ago

1.1.1

9 years ago

1.1.0

9 years ago

1.0.9

9 years ago

1.0.8

9 years ago

1.0.7

10 years ago

1.0.6

10 years ago

1.0.5

10 years ago

1.0.4

11 years ago

1.0.3

11 years ago

1.0.2

11 years ago

1.0.1

11 years ago

1.0.0

11 years ago