README.md

parse-redis-url-simple parsing redis urls with sentinel support

Simple parser for redis url. It supports sentinel urls for ioredis

Module usage

const parseRedisUrl = require('parse-redis-url-simple')

// Defaults to localhost:6379/0
parseRedisUrl()
//=> [{host: 'localhost', port: 6379, database: '0', password: undefined}]
parseRedisUrl('redis://')
//=> [{host: 'localhost', port: 6379, database: '0', password: undefined}]

// But you can change databases by adding a path
parseRedisUrl('redis:///1')
//=> [{host: 'localhost', port: 6379, database: '1', password: undefined}]

// Many instances
parseRedisUrl('redis://barhost.com:39143/,redis://foohost.com:39143/')
//=> [{host: 'barhost.com', port: 39143, database: '0', password: undefined}, 
//=>  {host: 'foohost.com', port: 39143, database: '0', password: undefined}]

// And even add passwords
parseRedisUrl('redis://[email protected]:39143/')
parseRedisUrl('redis://:[email protected]:39143/')
//=> [{host: 'foohost.com', port: 39143, database: '0', password: 'n9y25ah7'}]

// If you add a username, it's ignored
parseRedisUrl('redis://user:[email protected]:39143/')
//=> [{host: 'foohost.com', port: 39143, database: '0', password: 'hunter2'}]

// For sentinels: just set parameter sentinel=true
parseRedisUrl('barhost.com:39143,foohost.com:39143,foobarhost.com:39143', sentinel=true)
//=> [{host: 'barhost.com', port: 39143},{host: 'foohost.com', port: 39143},{host: 'foobarhost.com', port: 39143}]

More examples

Could be found here:

• tests: the set of unit tests.

Prior art

All implementations

• parse-redis-url
• redis-url
• redis-url-parser
• redis-url-parse

are not maintained or not for production use. It looks they were implemented only for testing purposes. Usually there have been more than one redis server in production. Moreover sometimes it is implemented via cluster or sentinel.