diff --git a/README.md b/README.md index a03106eabb..582fc80928 100644 --- a/README.md +++ b/README.md @@ -164,14 +164,16 @@ If you have `redis-server` running on the same computer as node, then the defaul port and host are probably fine and you don't need to supply any arguments. `createClient()` returns a `RedisClient` object. ### overloading -* `redis.createClient(port, host, options)` -* `redis.createClient()` is equivalent to `redis.createClient(6379, '127.0.0.1', {})` -* `redis.createClient(options)` is equivalent to `redis.createClient(6379, '127.0.0.1', options)` +* `redis.createClient()` +* `redis.createClient(options)` * `redis.createClient(unix_socket, options)` * `redis.createClient('redis://user:pass@host:port', options)` +* `redis.createClient(port, host, options)` `options` is an object with the following possible properties: +* `host`: *127.0.0.1*; The host to connect to +* `port`: *6370*; The port to connect to * `parser`: *hiredis*; Which Redis protocol reply parser to use. If `hiredis` is not installed it will fallback to `javascript`. * `return_buffers`: *false*; If set to `true`, then all replies will be sent to callbacks as Buffers instead of Strings. * `detect_buffers`: *false*; If set to `true`, then replies will be sent to callbacks as Buffers diff --git a/changelog.md b/changelog.md index ab0147265d..b573948e28 100644 --- a/changelog.md +++ b/changelog.md @@ -7,6 +7,7 @@ Features: - Addded optional flush parameter to `.end`. If set to true, commands fired after using .end are going to be rejected instead of being ignored. (@crispy1989) - Addded: host and port can now be provided in a single options object. E.g. redis.createClient({ host: 'localhost', port: 1337, max_attempts: 5 }); (@BridgeAR) +- Speedup common cases (@BridgeAR) Bugfixes: