# @ethanfrogers/catbox-redis

> Redis adapter for catbox

Latest version **2.0.2** (published 2017-01-18) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @ethanfrogers/catbox-redis
pnpm add @ethanfrogers/catbox-redis
yarn add @ethanfrogers/catbox-redis
bun add @ethanfrogers/catbox-redis
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2017-01-18 |
| First published | 2017-01-18 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| Author | Ethan Rogers |
| Maintainers | ethanfrogers |
| Keywords | cache, catbox, redis |

## Links

- npm: https://www.npmjs.com/package/@ethanfrogers/catbox-redis
- Repository: https://github.com/hapijs/catbox-redis
- Homepage: https://github.com/hapijs/catbox-redis#readme
- Issues: https://github.com/hapijs/catbox-redis/issues
- npm.io page: https://npm.io/package/@ethanfrogers/catbox-redis

## Dependencies (2)

- [hoek](https://npm.io/package/hoek.md) 4.x.x
- [redis](https://npm.io/package/redis.md) 2.x.x

## Alternatives

- [memory-cache](https://npm.io/package/memory-cache.md) — 795.0K weekly downloads
- [@httptoolkit/proxy-agent](https://npm.io/package/@httptoolkit/proxy-agent.md) — 11.2K weekly downloads
- [express-cache-controller](https://npm.io/package/express-cache-controller.md) — 5.3K weekly downloads
- [http-cache-middleware](https://npm.io/package/http-cache-middleware.md) — 4.5K weekly downloads
- [cache2](https://npm.io/package/cache2.md) — 1.5K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2017-01-18

## README

catbox-redis [![Build Status](https://travis-ci.org/hapijs/catbox-redis.svg?branch=master)](https://travis-ci.org/hapijs/catbox-redis)
============

Redis adapter for catbox

Lead Maintainer: [Loic Mahieu](https://github.com/LoicMahieu)

## Options

- `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: '')

## 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](./.travis.yml)

```sh
redis-server&
npm test
```

---
_Source: https://npm.io/package/@ethanfrogers/catbox-redis · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
