hapi-redis2's Introduction

Forked from ttps://github.com/midnightcodr/hapi-redis2 but with updated deps

About

Inspired by https://github.com/Marsup/hapi-mongodb, here's an ioredis plugin for hapijs that supports multiple connections.

Notes

Starting from version 2, this plugin switches to ioredis as the redis client
Starting from version 1.0.0 this plugin only supports Hapi version 17 and above. If you are using hapijs prior to version 17, please check out version 0.9.11-a

Options

decorate: string or boolean, mixed use of different types of decorate settings are not allowed.
settings: can be

A) null, redis client will be initialized with new Redis(), which connects to the redis server running on localhost at port 6379 without authentication.

B) an object,

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

C) a url string,

'redis://:[email protected]:6379/4'

Note prior to v2, the url option was used.

Installation

npm install hapi-redis2

Example

const Hapi = require('@hapi/hapi')
const Boom = require('@hapi/boom')

const launchServer = async function () {
  const clientOpts = {
    settings: 'redis://[email protected]:6379/2',
    decorate: true
  }

  const server = Hapi.Server({ port: 8080 })

  await server.register({
    plugin: require('hapi-redis2'),
    options: clientOpts
  })

  server.route({
    method: 'GET',
    path: '/redis/{val}',
    async handler(request) {
      const client = request.redis.client

      try {
        await client.set('hello', request.params.val)
        return {
          result: 'ok'
        }
      } catch (err) {
        throw Boom.internal('Internal Redis error')
      }
    }
  })

  await server.start()
  console.log(`Server started at ${server.info.uri}`)
}

launchServer().catch((err) => {
  console.error(err)
  process.exit(1)
})