Skip to content

Commit 044db8c

Browse files
author
Ruben Bridgewater
committed
Update the readme + changelog
1 parent adee239 commit 044db8c

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,14 +164,16 @@ If you have `redis-server` running on the same computer as node, then the defaul
164164
port and host are probably fine and you don't need to supply any arguments. `createClient()` returns a `RedisClient` object.
165165

166166
### overloading
167-
* `redis.createClient(port, host, options)`
168-
* `redis.createClient()` is equivalent to `redis.createClient(6379, '127.0.0.1', {})`
169-
* `redis.createClient(options)` is equivalent to `redis.createClient(6379, '127.0.0.1', options)`
167+
* `redis.createClient()`
168+
* `redis.createClient(options)`
170169
* `redis.createClient(unix_socket, options)`
171170
* `redis.createClient('redis://user:pass@host:port', options)`
171+
* `redis.createClient(port, host, options)`
172172

173173
`options` is an object with the following possible properties:
174174

175+
* `host`: *127.0.0.1*; The host to connect to
176+
* `port`: *6370*; The port to connect to
175177
* `parser`: *hiredis*; Which Redis protocol reply parser to use. If `hiredis` is not installed it will fallback to `javascript`.
176178
* `return_buffers`: *false*; If set to `true`, then all replies will be sent to callbacks as Buffers instead of Strings.
177179
* `detect_buffers`: *false*; If set to `true`, then replies will be sent to callbacks as Buffers

changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Features:
77

88
- 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)
99
- 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)
10+
- Speedup common cases (@BridgeAR)
1011

1112
Bugfixes:
1213

0 commit comments

Comments
 (0)